opal-browser 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a728e0d53d58c89018baa0d46dbc4731da85966b7fb5b7b312f4bb24d9dc23f
-  data.tar.gz: 7219cd2463a99d60f4f39b19045ab3ebf22b254a62f82c4684bd3023ad7548e4
+  metadata.gz: 16a070e0b1c644fc54d33c3266f0c470a920cac127bc4b37ede951f55f76517f
+  data.tar.gz: 7895a72bebd9b3528fcd1b714a603355f83b9fb3c34ea610f3bc4157a5eb8b93
 SHA512:
-  metadata.gz: a04d4225b59e9e3d244bfa748d931bc3954946c9de3e6f4623115494e00e54a8a5c3e90bf7fe679b71d1ebc74b7318c18f422014775059ca457bcd1cf872f250
-  data.tar.gz: 194e860d12c4e737593bc1888cff156fccfc94d13b20faf8ec26b12ed9a1d26d43ad960b21fb88a6605a5b8c20b8b2d4c239dec4a52013b87d1ab7ec9649c372
+  metadata.gz: 3e08c691cfc2f4c633c3467a7ed8059690ded3bbcf3759e2c5b5333f220f67752caf4d13316dd956e87304f192732ca027434810b1c6a0f77cc7e039fa5fa871
+  data.tar.gz: d724afddb0f157fe632275195ca01bc776129442cce3876fb0d6aea2d30202e81d0240c4666b5fe76837f5671398efa63f648f61e518fc7b7a7017fccb1817e7

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 0.3.2
+* Cookie: refactor the module
+  * Note in documentation it's available as `$document.cookies` and it's the preferred way to access it
+  * Always encode a cookie with JSON, unless a new parameter `raw:` is provided
+
+## 0.3.1
+* Element#inner_dom: Reduce flickering - first build tree, then insert it
+* NodeSet#to_a to be aliased to #to_ary

data/Gemfile

@@ -6,12 +6,12 @@ gem 'rake'
 gem 'rack'
 gem 'sinatra'
 gem 'sinatra-websocket'
-# For opal-rspec, a release is needed
-gem 'opal-rspec', github: 'hmdne/opal-rspec', branch: 'opal-1.3', submodules: true # '>= 0.8.0.alpha1'
+gem 'opal-rspec'
 gem 'opal-sprockets'
-# Force build of eventmachine on Windows
-gem 'eventmachine', github: 'eventmachine/eventmachine' if RUBY_PLATFORM =~ /mingw/
-
+# Force build of eventmachine... I wish we could find a way to not use
+# this unmaintained library anymore.
+gem 'eventmachine', github: 'eventmachine/eventmachine'
+gem 'thin', github: 'macournoyer/thin' unless RUBY_PLATFORM =~ /mingw/
 
 # runner
 gem 'selenium-webdriver', require: false

data/README.md

@@ -4,6 +4,9 @@ Opal-Browser - Client side web development in pure Ruby, using Opal
 [![Gem Version](https://badge.fury.io/rb/opal-browser.svg)](http://badge.fury.io/rb/opal-browser)
 [![Code Climate](https://img.shields.io/codeclimate/maintainability-percentage/opal/opal-browser.svg)](https://codeclimate.com/github/opal/opal-browser)
 [![Build Status](https://github.com/opal/opal-browser/workflows/build/badge.svg)](https://github.com/opal/opal-browser/actions?query=workflow%3Abuild)
+[![Join Chat](https://img.shields.io/badge/slack-join%20chat-46BC99?logo=slack&style=flat)](https://slack.opalrb.com/)
+[![Stack Overflow](https://img.shields.io/badge/stackoverflow-%23opalrb-orange.svg?style=flat)](https://stackoverflow.com/questions/ask?tags=opalrb,opal-browser)
+[![Documentation](https://img.shields.io/badge/docs-updated-blue.svg)](https://rubydoc.info/gems/opal-browser)
 
 This library aims to be a full-blown wrapper for all the browser API as defined by
 HTML5.
@@ -70,7 +73,7 @@ _And load it in HTML!_
 </html>
 ```
 
-See the examples/integrations/ directory for various ideas on how to quickly start
+See the `examples/integrations/` directory for various ideas on how to quickly start
 development using opal-browser.
 
 Features
@@ -109,6 +112,7 @@ Add an event to a given element:
 ```ruby
 $document.at_css("button").on(:click) do |e|
   e.prevent # Prevent the default action (eg. form submission)
+  # You can also use `e.stop` to stop propagating the event to other handlers.
   alert "Button clicked!"
 end
 ```
@@ -201,6 +205,17 @@ History
 -------
 The HTML5 History API has been fully wrapped.
 
+```ruby
+current = $window.history.current
+$window.history.replace("?get=params")
+$window.history.push("?get=params")
+$window.history.back
+
+$window.on :popstate do |e|
+  p "User clicked a back button! He is now on #{$window.history.current}"
+end
+```
+
 Storage
 -------
 The HTML5 Storage API has been wrapped and it exports a single Storage class

data/opal/browser/cookies.rb

@@ -1,5 +1,3 @@
-require 'stringio'
-
 module Browser
 
 # Allows manipulation of browser cookies.
@@ -8,10 +6,19 @@ module Browser
 #
 # Usage:
 #
-#   cookies = Browser::Cookies.new(`document`)
+#   cookies = $document.cookies
 #   cookies["my-cookie"] = "monster"
 #   cookies.delete("my-cookie")
 #
+# By default, cookies are stored JSON-encoded. You can supply a `raw:` option
+# whenever you need to access/write the cookies in a raw way, eg.
+#
+#   cookies["my-other-cookie", raw: true] = 123
+#
+# You can also set this option while referencing $document.cookies, eg.
+#
+#   cookies = $document.cookies(raw: true)
+#   cookies["my-other-cookie"] = 123
 class Cookies
   # Default cookie options.
   DEFAULT = {
@@ -26,24 +33,34 @@ class Cookies
   # Create a new {Cookies} wrapper.
   #
   # @param document [native] the native document object
-  def initialize(document)
+  # @param options [Hash] the default cookie options
+  def initialize(document, options = {})
     @document = document
-    @options  = DEFAULT.dup
+    @options  = DEFAULT.merge(options)
   end
 
   # Access the cookie with the given name.
   #
   # @param name [String] the name of the cookie
+  # @param options [Hash] the options for the cookie
+  #
+  # @option options [Boolean] :raw     get a raw cookie value, don't encode it with JSON
   #
   # @return [Object]
-  def [](name)
+  def [](name, options = {})
+    options = @options.merge(options)
+
     matches = `#@document.cookie`.scan(/#{Regexp.escape(FormData.encode(name))}=([^;]*)/)
 
     return if matches.empty?
 
-    result = matches.flatten.map {|value|
-      JSON.parse(FormData.decode(value))
-    }
+    result = matches.flatten.map do |value|
+      if options[:raw]
+        FormData.decode(value)
+      else
+        JSON.parse(FormData.decode(value))
+      end
+    end
 
     result.length == 1 ? result.first : result
   end
@@ -54,38 +71,45 @@ class Cookies
   # @param value [Object] the data to set
   # @param options [Hash] the options for the cookie
   #
+  # @option options [Boolean] :raw     don't encode a value with JSON
   # @option options [Integer] :max_age the max age of the cookie in seconds
   # @option options [Time]    :expires the expire date
   # @option options [String]  :path    the path the cookie is valid on
   # @option options [String]  :domain  the domain the cookie is valid on
   # @option options [Boolean] :secure  whether the cookie is secure or not
-  def []=(name, value, options = {})
-    string = value.is_a?(String) ? value : JSON.dump(value)
-    encoded_value = encode(name, string, @options.merge(options))
+  def []=(name, options = {}, value)
+    options = @options.merge(options)
+    if options[:raw]
+      string = value.to_s
+    else
+      string = JSON.dump(value)
+    end
+    encoded_value = encode(name, string, options)
     `#@document.cookie = #{encoded_value}`
   end
 
   # Delete a cookie.
   #
   # @param name [String] the name of the cookie
-  def delete(name)
+  def delete(name, _options = {})
     `#@document.cookie = #{encode name, '', expires: Time.now}`
   end
 
   # @!attribute [r] keys
   # @return [Array<String>] all the cookie names
-  def keys
-    Array(`#@document.cookie.split(/; /)`).map {|cookie|
+  def keys(_options = {})
+    Array(`#@document.cookie.split(/; /)`).map do |cookie|
       cookie.split(/\s*=\s*/).first
-    }
+    end
   end
 
   # @!attribute [r] values
   # @return [Array] all the cookie values
-  def values
-    keys.map {|key|
-      self[key]
-    }
+  def values(options = {})
+    options = @options.merge(options)
+    keys.map do |key|
+      self[key, options]
+    end
   end
 
   # Enumerate the cookies.
@@ -93,13 +117,18 @@ class Cookies
   # @yieldparam key [String] the name of the cookie
   # @yieldparam value [String] the value of the cookie
   #
+  # @param options [Hash] the options for the cookie
+  #
+  # @option options [Boolean] :raw     don't encode a value with JSON
+  #
   # @return [self]
-  def each(&block)
-    return enum_for :each unless block
+  def each(options = {}, &block)
+    return enum_for :each, options unless block
+    options = @options.merge(options)
 
-    keys.each {|key|
-      yield key, self[key]
-    }
+    keys.each do |key|
+      yield key, self[key, options]
+    end
 
     self
   end
@@ -107,17 +136,17 @@ class Cookies
   # Delete all the cookies
   #
   # @return [self]
-  def clear
-    keys.each {|key|
+  def clear(_options = {})
+    keys.each do |key|
       delete key
-    }
+    end
 
     self
   end
 
 protected
   def encode(key, value, options = {})
-    io = StringIO.new
+    io = []
 
     io << FormData.encode(key) << ?= << FormData.encode(value) << '; '
 
@@ -127,15 +156,15 @@ protected
     io << 'domain='  << options[:domain] << '; '         if options[:domain]
     io << 'secure'                                       if options[:secure]
 
-    io.string
+    io.join
   end
 end
 
 class DOM::Document < DOM::Element
   # @!attribute [r] cookies
   # @return [Cookies] the cookies for the document
-  def cookies
-    Cookies.new(@native) if defined?(`#@native.cookie`)
+  def cookies(options = {})
+    Cookies.new(@native, options) if defined?(`#@native.cookie`)
   end
 end
 

data/opal/browser/version.rb

@@ -1,3 +1,3 @@
 module Browser
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opal-browser
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - meh.
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-23 00:00:00.000000000 Z
+date: 2021-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opal
@@ -54,6 +54,7 @@ files:
 - ".github/workflows/build.yml"
 - ".gitignore"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md