opal · Jan 22, 2014 · Jan 22, 2014
Showing with 170 additions and 86 deletions.

+61 −0 opal/browser/compatibility/storage.rb

+0 −16 opal/browser/history.rb

+109 −70 opal/browser/storage.rb
diff --git a/opal/browser/compatibility/storage.rb b/opal/browser/compatibility/storage.rb
@@ -0,0 +1,61 @@
+module Browser
+
+module Compatibility
+  def self.local_storage?
+    has? :localStorage
+  end
+
+  def self.global_storage?
+    has? :globalStorage
+  end
+
+  def self.add_behavior?
+    has? `document.body`, :addBehavior
+  end
+end
+
+class Storage
+  unless C.local_storage?
+    if C.global_storage?
+      def init
+        replace `#@window.globalStorage[#@window.location.hostname][#{encoded_name}] || '{}'`
+      end
+
+      def save
+        `#@window.globalStorage[#@window.location.hostname][#{encoded_name}] = #{JSON.dump(self)}`
+      end
+    elsif C.add_behavior?
+      def init
+        %x{
+          #@element = #@window.document.createElement('link');
+          #@element.addBehavior('#default#userData');
+
+          #@window.document.getElementsByTagName('head')[0].appendChild(#@element);
+
+          #@element.load(#{encoded_name});
+        }
+
+        replace `#@element.getAttribute(#{encoded_name}) || '{}'`
+      end
+
+      def save
+        %x{
+          #@element.setAttribute(#{encoded_name}, #{JSON.dump(self)});
+          #@element.save(#{encoded_name});
+        }
+      end
+    else
+      def init
+        $document.cookies.options expires: 60 * 60 * 24 * 365
+
+        replace $document.cookies[encoded_name]
+      end
+
+      def save
+        $document.cookies[encoded_name] = self
+      end
+    end
+  end
+end
+
+end
diff --git a/opal/browser/history.rb b/opal/browser/history.rb
@@ -15,51 +15,35 @@ class History
   # Go back in the history.
   #
   # @param number [Integer] how many items to go back
-  #
-  # @return [self]
   def back(number = 1)
     `#@native.go(-number)`
-
-    self
   end
 
   # Go forward in the history.
   #
   # @param number [Integer] how many items to go forward
-  #
-  # @return [self]
   def forward(number = 1)
     `#@native.go(number)`
-
-    self
   end
 
   # Push an item in the history.
   #
   # @param item [String] the item to push in the history
   # @param data [Object] additional state to push
-  #
-  # @return [self]
   def push(item, data = nil)
     data = `null` if data.nil?
 
     `#@native.pushState(data, null, item)`
-
-    self
   end
 
   # Replace the current history item with another.
   #
   # @param item [String] the item to replace with
   # @param data [Object] additional state to replace
-  #
-  # @return [self]
   def replace(item, data = nil)
     data = `null` if data.nil?
 
     `#@native.replaceState(data, null, item)`
-
-    self
   end
 
   # @!attribute [r] current

diff --git a/opal/browser/storage.rb b/opal/browser/storage.rb
@@ -1,19 +1,24 @@
-#--
-#            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-#                    Version 2, December 2004
-#
-#            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-#   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-#
-#  0. You just DO WHAT THE FUCK YOU WANT TO.
-#++
-
 require 'json'
 require 'stringio'
 
 module Browser
 
-class Storage < Hash
+# A {Storage} allows you to store data across page loads and browser
+# restarts.
+#
+# Compatibility
+# -------------
+# The compatibility layer will try various implementations in the following
+# order.
+#
+# + [window.localStorage](https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Storage#localStorage)
+# + [window.globalStorage](https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Storage#globalStorage)
+# + [document.body.addBehavior](http://msdn.microsoft.com/en-us/library/ms531424(VS.85).aspx)
+# + [document.cookie](https://developer.mozilla.org/en-US/docs/Web/API/document.cookie)
+#
+# @see https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Storage
+# @todo remove method_defined? checks when require order is fixed
+class Storage
   def self.json_create(data)
     data.delete(JSON.create_id)
 
@@ -22,94 +27,112 @@ def self.json_create(data)
     }]
   end
 
+  include Enumerable
+
+  # @!attribute [r] name
+  # @return [String] the name of the storage
   attr_reader :name
 
+  # Create a new storage on the given window with the given name.
+  #
+  # @param window [native] the window to save the storage to
+  # @param name [String] the name to use to discern different storages
   def initialize(window, name)
     super()
 
     @window = window
     @name   = name
+    @data   = {}
 
     autosave!
-
-    init if respond_to? :init
+    init
   end
 
+  # @!attribute [r] encoded_name
+  # @return [String] the generated name
   def encoded_name
-    "$opal.storage.#{@name}"
+    "$opal.storage.#@name"
   end
 
-  def autosave?;    @autosave;         end
-  def autosave!;    @autosave = true;  end
-  def no_autosave!; @autosave = false; end
-
-  def replace(what)
-    if what.is_a?(String)
-      super JSON.parse(what)
-    else
-      super
-    end
+  # Check if autosaving is enabled.
+  #
+  # When autosaving is enabled the {Storage} is saved every time a change is
+  # made, otherwise you'll have to save it manually yourself.
+  def autosave?
+    @autosave
   end
 
-  %w([]= delete clear).each {|name|
-    define_method name do |*args|
-      # FIXME: remove the application when it's fixed
-      super(*args).tap {
-        save if autosave?
-      }
-    end
-  }
+  # Enable autosaving.
+  def autosave!
+    @autosave = true
+  end
 
-  def save; end
+  # Disable autosaving.
+  def no_autosave!
+    @autosave = false
+  end
 
-  if `window.localStorage`
-    def init
-      replace `#@window.localStorage[#{encoded_name}] || '{}'`
-    end
+  # Iterate over the (key, value) pairs in the storage.
+  #
+  # @yield [key, value]
+  def each(&block)
+    return enum_for :each unless block
 
-    def save
-      `#@window.localStorage[#{encoded_name}] = #{JSON.dump(self)}`
-    end
-  elsif `window.globalStorage`
-    def init
-      replace `#@window.globalStorage[#@window.location.hostname][#{encoded_name}] || '{}'`
-    end
+    @data.each(&block)
 
-    def save
-      `#@window.globalStorage[#@window.location.hostname][#{encoded_name}] = #{JSON.dump(self)}`
-    end
-  elsif `document.body.addBehavior`
-    def init
-      %x{
-        #@element = #@window.document.createElement('link');
-        #@element.addBehavior('#default#userData');
+    self
+  end
 
-        #@window.document.getElementsByTagName('head')[0].appendChild(#@element);
+  # Get a value in the storage.
+  def [](key)
+    @data[key]
+  end
 
-        #@element.load(#{encoded_name});
-      }
+  # Set a value in the storage.
+  def []=(key, value)
+    @data[key] = value
 
-      replace `#@element.getAttribute(#{encoded_name}) || '{}'`
-    end
+    save if autosave?
+  end
 
-    def save
-      %x{
-        #@element.setAttribute(#{encoded_name}, #{JSON.dump(self)});
-        #@element.save(#{encoded_name});
-      }
-    end
-  else
-    def init
-      $document.cookies.options expires: 60 * 60 * 24 * 365
+  # Delete a value from the storage.
+  def delete(key)
+    @data.delete(key).tap {
+      save if autosave
+    }
+  end
 
-      replace $document.cookies[encoded_name]
-    end
+  # Clear the storage.
+  def clear
+    @data.clear.tap {
+      save if autosave?
+    }
+  end
 
-    def save
-      $document.cookies[encoded_name] = self
+  # Replace the current storage with the given one.
+  #
+  # @param new [Hash, String] if new is a {String} it will be parsed as JSON
+  def replace(new)
+    if String === new
+      @data.replace(JSON.parse(new))
+    else
+      @data.replace(new)
     end
   end
 
+  # @private
+  def init
+    replace `#@window.localStorage[#{encoded_name}] || '{}'`
+  end unless method_defined? :init
+
+  # Save a snapshot of the storage.
+  def save
+    `#@window.localStorage[#{encoded_name}] = #{JSON.dump(self)}`
+  end unless method_defined? :save
+
+  # Convert the storage to JSON.
+  #
+  # @return [String] the JSON representation
   def to_json
     io = StringIO.new("{")
 
@@ -126,6 +149,10 @@ def to_json
   end
 end
 
+# A {SessionStorage} allows you to store data across page reloads, as long as the session
+# is active.
+#
+# @see https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Storage#sessionStorage
 class SessionStorage < Storage
   def init
     replace `#@window.sessionStorage[#{encoded_name}] || '{}'`
@@ -137,13 +164,25 @@ def save
 end
 
 class Window
+  # Get a storage with the given name.
+  #
+  # @param name [Symbol] the name of the storage
+  #
+  # @return [Storage]
   def storage(name = :default)
     Storage.new(to_n, name)
   end
 
+  # Get a session storage with the given name.
+  #
+  # @param name [Symbol] the name of the storage
+  #
+  # @return [SessionStorage]
   def session_storage(name = :default)
     SessionStorage.new(to_n, name)
   end
 end
 
 end
+
+require 'browser/compatibility/storage'