opal-ferro 0.10.0 → 0.10.1

data/opal/opal-ferro/ferro_sequence.js.rb

@@ -1,12 +1,23 @@
-class FerroSequence
-  
-  def initialize(label = nil)
-    @label   = label
-    @next_id = 0
-  end
+module Ferro
+  # A helper class to generate unique labels.
+  # These labels can be used to ensure
+  # unique instance variable names.
+  class Sequence
+
+    # Create a new sequence.
+    #
+    # @param [String] prefix a prefix for generated labels
+    def initialize(prefix = nil)
+      @prefix  = prefix
+      @next_id = 0
+    end
 
-  def next
-    @next_id += 1
-    "#{@label}#{@next_id}"
+    # Get the next label.
+    #
+    # @return [String] the unique label
+    def next
+      @next_id += 1
+      "#{@prefix}#{@next_id}"
+    end
   end
 end

data/opal/opal-ferro/ferro_xhr.js.rb

@@ -1,82 +1,145 @@
-# Based on turbolinks/http_request
-require 'json'
-require 'native'
-
-class FerroXhr
-
-  NETWORK_FAILURE = 'Network error'
-  TIMEOUT_FAILURE = 'Timeout'
-
-  def initialize(url, callback, error_callback, options = {})
-    @url            = url
-    @callback       = callback
-    @error_callback = error_callback
-    @referrer       = options[:referrer] || 'Ferro'
-    @timeout        = options[:timeout]  || 5000
-    @accept         = options[:accept]   || 'application/json'
-    @xhr            = nil
-    @sent           = false
-
-    createXHR
-    send
-  end
+module Ferro
+  require 'json'
+  require 'native'
+
+  # Create and execute AJAX requests.
+  # Based on turbolinks/http_request.
+  # Specify the url for the request and two callbacks,
+  # one for succesful completion of the request and one
+  # for a failed request.
+  #
+  # It is safe to destroy the FerroXhr instance after
+  # one of it's callbacks have completed.
+  # Note that there are no private methods in Opal. Methods that
+  # should be private are marked in the docs with 'Internal method'.
+  #
+  # This class can only send and receive JSON.
+  # For non-get requests a csrf token can be specified or left
+  # blank. When blank this class will try to find the token in
+  # the header meta data.
+  class Xhr
+
+    # Error message for timeouts.
+    TIMEOUT_FAILURE = 'Timeout'
+
+    # Start AJAX request.
+    #
+    # Valid options are:
+    # * :timeout (Integer) Request-timout
+    # * :accept (String) Header-Accept
+    # * :method (Symbol) Html method, default: :get
+    # * :csrf (String) Csrf token, if blank and method is not :get,
+    #   meta tag 'csrf-token' will be used
+    # * :body (Hash) Hash of parameters to be sent
+    #
+    # @param [String] url The url for the request
+    # @param [Method] callback Success callback method. The callback
+    #        method should accept one parameter [Hash] containing the
+    #        parsed json object returned by the AJAX call
+    # @param [Method] error_callback Failure callback method. The callback
+    #        method should accept two parameters [Integer, String]
+    #        containing the status and error message
+    # @param [Hash] options See valid options
+    def initialize(url, callback, error_callback, options = {})
+      @url            = url
+      @callback       = callback
+      @error_callback = error_callback
+      @timeout        = options[:timeout]  || 5000
+      @accept         = options[:accept]   || 'application/json'
+      @method         = (options[:method] || :get).upcase
+      @csrf           = options[:csrf]
+      @body           = options[:body] ? options[:body].to_json.to_s : nil
+      @xhr            = nil
+      @sent           = false
 
-  def send
-    if @xhr && !@sent
-      @xhr.JS.send
-      @sent = true
+      createXHR
+      send
     end
-  end
 
-  def cancel
-    @xhr.JS.abort if @xhr && @sent
-  end
+    # Internal method to start the AJAX request.
+    def send
+      if @xhr && !@sent
+        @xhr.JS.send(@body)
+        @sent = true
+      end
+    end
 
-  def createXHR
-    @xhr = `new XMLHttpRequest`
-    `#{@xhr}.open('GET', #{@url}, true)`
-    `#{@xhr}.timeout = #{@timeout}`
-  # `#{@xhr}.responseType = 'json'` if @accept == 'application/json'
-    `#{@xhr}.setRequestHeader('Accept', #{@accept})`
-    `#{@xhr}.setRequestHeader('Ferro-Referrer', #{@referrer})`
-    `#{@xhr}.addEventListener('load',    function(){#{requestLoaded}})`
-    `#{@xhr}.addEventListener('error',   function(){#{requestFailed}})`
-    `#{@xhr}.addEventListener('timeout', function(){#{requestTimedOut}})`
-    `#{@xhr}.addEventListener('abort',   function(){#{requestCanceled}})`
-    nil
-  end
+    # Cancel a running AJAX request.
+    def cancel
+      @xhr.JS.abort if @xhr && @sent
+    end
 
-  def destroy
-    `#{@xhr} = null`
-  end
+    # Internal method to set up the AJAX request.
+    def createXHR
+      @xhr = `new XMLHttpRequest`
 
-  def requestLoaded
-    begin
-      status = Native(`#{@xhr}.status`)
-      raise if status >= 300
-      json = JSON.parse(`#{@xhr}.response`)
-      @callback.call(json)
-    rescue => error
-      @failed = true
-      @error_callback.call(status, error)
+      `#{@xhr}.open(#{@method}, #{@url}, true)`
+      `#{@xhr}.timeout = #{@timeout}`
+      `#{@xhr}.setRequestHeader('Accept', #{@accept})`
+
+      if @method != 'GET'
+        `#{@xhr}.setRequestHeader('X-CSRF-Token', #{csrf_token})`
+        if @body
+          `#{@xhr}.setRequestHeader('Content-Type', #{@accept})`
+          `#{@xhr}.setRequestHeader('Content-Length', #{@body.length})`
+        end
+      end
+
+      `#{@xhr}.addEventListener('load',    function(){#{requestLoaded}})`
+      `#{@xhr}.addEventListener('error',   function(){#{requestFailed}})`
+      `#{@xhr}.addEventListener('timeout', function(){#{requestTimedOut}})`
+      `#{@xhr}.addEventListener('abort',   function(){#{requestCanceled}})`
+      nil
     end
 
-    destroy
-  end
+    # Internal method to get the csrf token from header meta data.
+    def csrf_token
+      return @csrf if @csrf
+      token = Native(`document.getElementsByName('csrf-token')`)
+      @csrf = token[0].content if token.length > 0
+    end
 
-  def requestFailed
-    @failed = true
-    @error_callback.call(`#{@xhr}.status`, Native(`#{@xhr}.response`))
-    destroy
-  end
+    # Internal method to clean up the AJAX request.
+    def destroy
+      `#{@xhr} = null`
+    end
 
-  def requestTimedOut
-    @failed = true
-    @error_callback.call(0, TIMEOUT_FAILURE)
-    destroy
-  end
+    # Internal callback method, will call the success callback specified
+    # in initialize or the failure callback if the html return status is
+    # 300 or higher.
+    def requestLoaded
+      begin
+        status = Native(`#{@xhr}.status`)
+        raise if status >= 300
+        json = JSON.parse(`#{@xhr}.response`)
+        @callback.call(json)
+      rescue => error
+        @failed = true
+        @error_callback.call(status, error)
+      end
 
-  def requestCanceled
-    destroy
+      destroy
+    end
+
+    # Internal callback method, will call the failure callback specified
+    # in initialize.
+    def requestFailed
+      @failed = true
+      @error_callback.call(`#{@xhr}.status`, Native(`#{@xhr}.response`))
+      destroy
+    end
+
+    # Internal callback method, will call the failure callback specified
+    # in initialize.
+    def requestTimedOut
+      @failed = true
+      @error_callback.call(0, TIMEOUT_FAILURE)
+      destroy
+    end
+
+    # Internal callback method.
+    def requestCanceled
+      destroy
+    end
   end
 end

data/opal/opal-ferro.rb

@@ -1,11 +1,13 @@
 require 'opal'
 require 'opal-ferro/ferro_elementary'
-require 'opal-ferro/ferro_element'
+require 'opal-ferro/ferro_base_element'
 require 'opal-ferro/ferro_document'
 require 'opal-ferro/ferro_factory'
 require 'opal-ferro/ferro_router'
 require 'opal-ferro/ferro_xhr'
 require 'opal-ferro/ferro_sequence'
-require 'opal-ferro/ferro_base_elements'
-require 'opal-ferro/ferro_form_elements'
-require 'opal-ferro/ferro_components'
+require 'opal-ferro/elements/ferro_inline'
+require 'opal-ferro/elements/ferro_components'
+require 'opal-ferro/elements/ferro_form'
+require 'opal-ferro/elements/ferro_misc'
+require 'opal-ferro/elements/ferro_combos'

data/opal-ferro.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'bundler',  '~> 1.16'
   s.add_development_dependency 'rake',     '~> 10.0'
-  # s.add_development_dependency 'yard',     '~> 0.8.7'
+  s.add_development_dependency 'yard',     '~> 0.9.12'
   s.add_development_dependency 'minitest', '~> 5.0'
   # s.add_development_dependency 'selenium-webdriver', '~> 3.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opal-ferro
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Ivo Herweijer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-02 00:00:00.000000000 Z
+date: 2018-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opal
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -77,23 +91,28 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- docs/GettingStarted.md
 - lib/opal-ferro.rb
 - lib/opal-ferro/version.rb
 - lib/opal/ferro.rb
 - opal-ferro.gemspec
 - opal/opal-ferro.rb
-- opal/opal-ferro/ferro_base_elements.js.rb
-- opal/opal-ferro/ferro_components.js.rb
+- opal/opal-ferro/elements/ferro_combos.js.rb
+- opal/opal-ferro/elements/ferro_components.js.rb
+- opal/opal-ferro/elements/ferro_form.js.rb
+- opal/opal-ferro/elements/ferro_inline.js.rb
+- opal/opal-ferro/elements/ferro_misc.js.rb
+- opal/opal-ferro/ferro_base_element.js.rb
 - opal/opal-ferro/ferro_document.js.rb
-- opal/opal-ferro/ferro_element.js.rb
 - opal/opal-ferro/ferro_elementary.js.rb
 - opal/opal-ferro/ferro_factory.js.rb
-- opal/opal-ferro/ferro_form_elements.js.rb
 - opal/opal-ferro/ferro_router.js.rb
 - opal/opal-ferro/ferro_sequence.js.rb
 - opal/opal-ferro/ferro_xhr.js.rb
@@ -117,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: 'Simplifying web-development: no more html, just beautiful and simple Ruby

data/opal/opal-ferro/ferro_base_elements.js.rb

@@ -1,158 +0,0 @@
-class FerroElementComponent < FerroElement
-  def component
-    self
-  end
-end
-
-# Semantical elements
-class FerroElementHeader < FerroElementComponent
-  def _before_create
-    @domtype = :header
-  end
-end
-
-class FerroElementNavigation < FerroElementComponent
-  def _before_create
-    @domtype = :nav
-  end
-end
-
-class FerroElementSection < FerroElementComponent
-  def _before_create
-    @domtype = :section
-  end
-end
-
-class FerroElementArticle < FerroElementComponent
-  def _before_create
-    @domtype = :article
-  end
-end
-
-class FerroElementAside < FerroElementComponent
-  def _before_create
-    @domtype = :aside
-  end
-end
-
-class FerroElementFooter < FerroElementComponent
-  def _before_create
-    @domtype = :footer
-  end
-end
-
-FerroElementBlock = FerroElement
-
-# Inline elements
-class FerroElementText < FerroElement
-  def _before_create
-    @size    = option_replace :size, 0
-    @domtype = @size == 0 ? :p : "h#{@size}"
-  end
-end
-
-class FerroElementList < FerroElement
-  def _before_create
-    @domtype = @options.has_key?(:type) ? :ol : :ul
-    @items   = []
-    @id      = FerroSequence.new 'list_'
-  end
-
-  def add_item(element_class, options = {})
-    @items << add_child(@id.next, element_class, options).sym
-  end
-
-  def item_count
-    @items.length
-  end
-
-  def first_item
-    @children[@items.first]
-  end
-
-  def last_item
-    @children[@items.last]
-  end
-
-  def unlist_item(sym)
-    @items.delete_if { |item| item == sym }
-  end
-end
-
-class FerroElementListItem < FerroElement
-  def _before_create
-    @domtype = :li
-  end
-
-  def destroy
-    super
-    parent.unlist_item(@sym)
-  end
-end
-
-class FerroElementAnchor < FerroElement
-  def _before_create
-    @domtype = :a
-    @href = @options[:href]
-  end
-
-  def _after_create
-    `#{@element}.addEventListener("click",function(e){e.preventDefault();history.pushState(null,null,#{@href});#{clicked};document.activeElement.blur();})`
-  end
-
-  def update_href(value)
-    @href = value
-    set_attribute('href', @href)
-  end
-
-  def clicked
-    router.navigated
-  end
-end
-
-class FerroElementExternalLink < FerroElement
-  def _before_create
-    @domtype = :a
-    @options[:target] ||= '_blank'
-  end
-end
-
-# Miscellaneous elements
-class FerroElementImage < FerroElement
-
-  # Todo use:
-  # <figure>
-  # <figcaption>
-  
-  def _before_create
-    @domtype = :img
-    @options[:alt] ||= @options[:src]
-  end
-end
-
-class FerroElementCanvas < FerroElement
-  def _before_create
-    @domtype = :canvas
-  end
-end
-
-class FerroElementScript < FerroElement
-  def _before_create
-    @domtype = :script
-    @run     = option_replace :invoke, true
-  end
-
-  def _after_create
-    load
-    invoke if @run
-  end
-
-  def load;end
-  def invoke;end
-end
-
-class FerroElementVar < FerroElement
-  def _before_create
-    @domtype = option_replace :domtype, :div
-  end
-end

data/opal/opal-ferro/ferro_components.js.rb

@@ -1,92 +0,0 @@
-# A component with a text entry field and submit button
-class FerroFormSearch < FerroForm
-  
-  def _before_create
-    @button_text = option_replace :button_text, ' '
-    @placeholder = option_replace :placeholder, ' Search...'
-  end
-
-  def cascade
-    add_child :entry,  FerroFormSearchInput,  { placeholder: @placeholder }
-    add_child :submit, FerroFormSearchSubmit, { content: @button_text }
-  end
-
-  def do_submit
-    value = entry.value.strip
-    submitted(value) if !value.empty?
-
-    entry.toggle_state :search_input_open
-    submit.toggle_state :search_submit_open
-
-    entry.value = nil
-    entry.set_focus if entry.state_active?(:search_input_open)
-  end
-
-  def submitted(value);end
-end
-
-class FerroFormSearchInput < FerroFormInput
-
-  def _after_create
-    add_state :search_input_open
-    super
-  end
-
-  def entered
-    parent.do_submit
-  end
-end
-
-class FerroFormSearchSubmit < FerroFormButton
-
-  def _after_create
-    add_state :search_submit_open
-    super
-  end
-
-  def clicked
-    parent.do_submit
-  end
-end
-
-# A simple pull-down menu
-# @option[items]: a list of classes
-class FerroPullDown < FerroElementBlock
-
-  def _before_create
-    @title_text = option_replace :title, '='
-    @items      = option_replace :items, []
-    super
-  end
-
-  def _after_create
-    add_state :pull_down_open
-    super
-  end
-
-  def cascade
-    add_child :title, FerroPullDownTitle, { content: @title_text }
-    add_child :items, FerroPullDownItems, { items:   @items }
-  end
-end
-
-class FerroPullDownTitle < FerroFormBlock
-  def clicked
-    parent.toggle_state :pull_down_open
-  end
-end
-
-class FerroPullDownItems < FerroElementBlock
-
-  def _before_create
-    @id       = FerroSequence.new 'pdi_'
-    @itemlist = option_replace :items, []
-    super
-  end
-
-  def cascade
-    @items = @itemlist.map do |item|
-      add_child @id.next, item
-    end
-  end
-end