RubyGems - ovto - Versions diffs - 0.2.0 - Mend

ovto 0.2.0

Files changed (105) hide show

checksums.yaml +7 -0
data/.gitignore +1 -0
data/.gitmodules +3 -0
data/CHANGELOG.md +22 -0
data/Gemfile +7 -0
data/Gemfile.lock +57 -0
data/LICENSE.txt +44 -0
data/README.md +84 -0
data/Rakefile +41 -0
data/book/README.md +1 -0
data/book/SUMMARY.md +13 -0
data/book/api/actions.md +77 -0
data/book/api/app.md +86 -0
data/book/api/component.md +175 -0
data/book/api/fetch.md +42 -0
data/book/api/state.md +97 -0
data/book/guides/debugging.md +23 -0
data/book/guides/development.md +11 -0
data/book/guides/tutorial.md +288 -0
data/book/screenshot.png +0 -0
data/docs/api/Ovto/Actions.html +135 -0
data/docs/api/Ovto/App.html +531 -0
data/docs/api/Ovto/Component/MoreThanOneNode.html +135 -0
data/docs/api/Ovto/Component.html +350 -0
data/docs/api/Ovto/Runtime.html +315 -0
data/docs/api/Ovto/State/MissingValue.html +135 -0
data/docs/api/Ovto/State/UnknownKey.html +135 -0
data/docs/api/Ovto/State.html +699 -0
data/docs/api/Ovto/WiredActions.html +343 -0
data/docs/api/Ovto.html +319 -0
data/docs/api/_index.html +229 -0
data/docs/api/actions.html +398 -0
data/docs/api/app.html +411 -0
data/docs/api/class_list.html +51 -0
data/docs/api/component.html +469 -0
data/docs/api/css/common.css +1 -0
data/docs/api/css/full_list.css +58 -0
data/docs/api/css/style.css +499 -0
data/docs/api/file.README.html +162 -0
data/docs/api/file_list.html +56 -0
data/docs/api/frames.html +17 -0
data/docs/api/index.html +162 -0
data/docs/api/js/app.js +248 -0
data/docs/api/js/full_list.js +216 -0
data/docs/api/js/jquery.js +4 -0
data/docs/api/method_list.html +243 -0
data/docs/api/state.html +430 -0
data/docs/api/top-level-namespace.html +110 -0
data/docs/gitbook/fonts/fontawesome/FontAwesome.otf +0 -0
data/docs/gitbook/fonts/fontawesome/fontawesome-webfont.eot +0 -0
data/docs/gitbook/fonts/fontawesome/fontawesome-webfont.svg +685 -0
data/docs/gitbook/fonts/fontawesome/fontawesome-webfont.ttf +0 -0
data/docs/gitbook/fonts/fontawesome/fontawesome-webfont.woff +0 -0
data/docs/gitbook/fonts/fontawesome/fontawesome-webfont.woff2 +0 -0
data/docs/gitbook/gitbook-plugin-fontsettings/fontsettings.js +240 -0
data/docs/gitbook/gitbook-plugin-fontsettings/website.css +291 -0
data/docs/gitbook/gitbook-plugin-highlight/ebook.css +135 -0
data/docs/gitbook/gitbook-plugin-highlight/website.css +434 -0
data/docs/gitbook/gitbook-plugin-lunr/lunr.min.js +7 -0
data/docs/gitbook/gitbook-plugin-lunr/search-lunr.js +59 -0
data/docs/gitbook/gitbook-plugin-search/lunr.min.js +7 -0
data/docs/gitbook/gitbook-plugin-search/search-engine.js +50 -0
data/docs/gitbook/gitbook-plugin-search/search.css +35 -0
data/docs/gitbook/gitbook-plugin-search/search.js +213 -0
data/docs/gitbook/gitbook-plugin-sharing/buttons.js +90 -0
data/docs/gitbook/gitbook.js +4 -0
data/docs/gitbook/images/apple-touch-icon-precomposed-152.png +0 -0
data/docs/gitbook/images/favicon.ico +0 -0
data/docs/gitbook/style.css +9 -0
data/docs/gitbook/theme.js +4 -0
data/docs/guides/debugging.html +355 -0
data/docs/guides/development.html +361 -0
data/docs/guides/tutorial.html +571 -0
data/docs/index.html +422 -0
data/docs/screenshot.png +0 -0
data/docs/search_index.json +1 -0
data/example/sinatra/Gemfile +6 -0
data/example/sinatra/Gemfile.lock +59 -0
data/example/sinatra/README.md +21 -0
data/example/sinatra/app.rb +18 -0
data/example/sinatra/config.ru +30 -0
data/example/sinatra/ovto/app.rb +171 -0
data/example/sinatra/public/style.css +4 -0
data/example/sinatra/public/todomvc-app-css_index.css +376 -0
data/example/sinatra/public/todomvc-common_base.css +141 -0
data/example/sinatra/views/index.erb +21 -0
data/example/static/Gemfile +3 -0
data/example/static/Gemfile.lock +30 -0
data/example/static/README.md +10 -0
data/example/static/Rakefile +4 -0
data/example/static/app.js +24808 -0
data/example/static/app.rb +43 -0
data/example/static/index.html +11 -0
data/lib/ovto/actions.rb +10 -0
data/lib/ovto/app.rb +58 -0
data/lib/ovto/component.rb +191 -0
data/lib/ovto/fetch.rb +53 -0
data/lib/ovto/runtime.rb +388 -0
data/lib/ovto/state.rb +69 -0
data/lib/ovto/version.rb +3 -0
data/lib/ovto/wired_actions.rb +33 -0
data/lib/ovto.rb +50 -0
data/ovto.gemspec +22 -0
data/screenshot.png +0 -0
metadata +161 -0

data/example/static/app.rb ADDED Viewed

@@ -0,0 +1,43 @@
+require 'ovto'
+class MyApp < Ovto::App
+  class State < Ovto::State
+    item :celsius, default: 0
+    def fahrenheit
+      (celsius * 9 / 5.0) + 32
+    end
+  end
+  class Actions < Ovto::Actions
+    def set_celsius(state:, value:)
+      return {celsius: value}
+    end
+    def set_fahrenheit(state:, value:)
+      new_celsius = (value - 32) * 5 / 9.0
+      return {celsius: new_celsius}
+    end
+  end
+  class View < Ovto::Component
+    def render(state:)
+      o 'div' do
+        o 'span', 'Celcius:'
+        o 'input', {
+          type: 'text',
+          onchange: ->(e){ actions.set_celsius(value: e.target.value.to_i) },
+          value: state.celsius
+        }
+        o 'span', 'Fahrenheit:'
+        o 'input', {
+          type: 'text',
+          onchange: ->(e){ actions.set_fahrenheit(value: e.target.value.to_i) },
+          value: state.fahrenheit
+        }
+      end
+    end
+  end
+end
+MyApp.run(id: 'ovto-view')

data/example/static/index.html ADDED Viewed

@@ -0,0 +1,11 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <script type='text/javascript' src='app.js'></script>
+  </head>
+  <body>
+    <div id='ovto-view'></div>
+    <div id='ovto-debug'></div>
+  </body>
+</html>

data/lib/ovto/actions.rb ADDED Viewed

@@ -0,0 +1,10 @@
+module Ovto
+  # Base class for ovto actions.
+  class Actions
+    attr_writer :wired_actions
+    def actions
+      @wired_actions
+    end
+  end
+end

data/lib/ovto/app.rb ADDED Viewed

@@ -0,0 +1,58 @@
+module Ovto
+  class App
+    # Create an App and start it
+    def self.run(*args)
+      new.run(*args)
+    end
+    def initialize
+      @state = self.class.const_get('State').new
+      @wired_actions = nil
+    end
+    attr_reader :state
+    def actions
+      @wired_actions
+    end
+    # Internal use only
+    def _set_state(new_state)
+      @state = new_state
+    end
+    # Start this app
+    def run(*args)
+      Ovto.log_error{ _run(*args) }
+    end
+    # Called when this app is started
+    def setup
+      # override this if needed
+    end
+    private
+    # Setup runtime and wired_actions
+    def _run(id: nil)
+      runtime = Ovto::Runtime.new(self)
+      actions = self.class.const_get('Actions').new
+      @wired_actions = WiredActions.new(actions, self, runtime)
+      actions.wired_actions = @wired_actions
+      view = self.class.const_get('View').new(@wired_actions)
+      if id
+        %x{
+          document.addEventListener('DOMContentLoaded', function(){
+            var container = document.getElementById(id);
+            if (!container) {
+              throw "Ovto::App#run: tag with id='" + id + "' was not found";
+            }
+            #{runtime.run(view, `container`)}
+          });
+        }
+      else
+        runtime.run(view, nil)
+      end
+      setup
+    end
+  end
+end

data/lib/ovto/component.rb ADDED Viewed

@@ -0,0 +1,191 @@
+module Ovto
+  class Component
+    # `render` tried to yield multiple nodes
+    class MoreThanOneNode < StandardError; end
+    def self.hash_to_js_obj(hash)
+      ret = `{}`
+      hash.each do |k, v|
+        `ret[k] = v`
+      end
+      ret
+    end
+    def initialize(wired_actions)
+      @wired_actions = wired_actions
+      # Initialize here for the unit tests
+      @vdom_tree = []
+    end
+    def render
+      ''
+    end
+    private
+    # Render entire MyApp::View
+    # Called from runtime.rb
+    def render_view(state)
+      do_render(state: state)
+    end
+    def do_render(**args)
+      @vdom_tree = []
+      @done_render = false
+      @current_state = args[:state]
+      parameters = method(:render).parameters
+      if `!parameters` || parameters.nil? || accepts_state?(parameters)
+        # We can pass `state:` safely
+        return render(**args)
+      else
+        # Remove `state:` keyword
+        args_wo_state = args.reject{|k, v| k == :state}
+        # Check it is empty (see https://github.com/opal/opal/issues/1872)
+        return args_wo_state.empty? ? render() : render(**args_wo_state)
+      end
+    end
+    # Return true if the method accepts `state:` keyword
+    def accepts_state?(parameters)
+      parameters.each do |item|
+        return true if item == [:key, :state] ||
+                       item == [:keyreq, :state] ||
+                       item[0] == :keyrest
+      end
+      return false
+    end
+    def actions
+      @wired_actions
+    end
+    # o 'div', 'Hello.'
+    # o 'div', class: 'main', 'Hello.'
+    # o 'div', style: {color: 'red'}, 'Hello.'
+    # o 'div.main'
+    # o 'div#main'
+    # o 'div' do 'Hello.' end
+    # o 'div' do
+    #   o 'h1', 'Hello.'
+    # end
+    def o(_tag_name, arg1=nil, arg2=nil, &block)
+      if arg1.is_a?(Hash)
+        attributes = arg1
+        content = arg2
+      elsif arg2 == nil
+        attributes = {}
+        content = arg1
+      else
+        raise ArgumentError
+      end
+      children = render_children(content, block)
+      case _tag_name
+      when Class
+        result = render_component(_tag_name, attributes, children)
+      when 'text'
+        unless attributes.empty?
+          raise ArgumentError, "text cannot take attributes"
+        end
+        result = content
+      when String
+        tag_name, base_attributes = *extract_attrs(_tag_name)
+        # Ignore nil/false
+        more_attributes = attributes.reject{|k, v| !v}
+        result = render_tag(tag_name, merge_attrs(base_attributes, more_attributes), children)
+      else
+        raise TypeError, "tag_name must be a String or Component but got "+
+          Ovto.inspect(tag_name)
+      end
+      if @vdom_tree.empty?
+        if @done_render
+          raise MoreThanOneNode, "#{self.class}#render must generate a single DOM node. Please wrap the tags with a 'div' or something."
+        end
+        @done_render = true
+        return result
+      else
+        @vdom_tree.last.push(result)
+        return @vdom_tree.last
+      end
+    end
+    def extract_attrs(tag_name)
+      case tag_name
+      when /^([^.#]*)\.([-_\w]+)(\#([-_\w]+))?/  # a.b#c
+        tag_name, class_name, id = ($1.empty? ? 'div' : $1), $2, $4
+      when /^([^.#]*)\#([-_\w]+)(\.([-_\w]+))?/  # a#b.c
+        tag_name, class_name, id = ($1.empty? ? 'div' : $1), $4, $2
+      else
+        class_name = id = nil
+      end
+      attributes = {}
+      attributes[:class] = class_name if class_name
+      attributes[:id] = id if id
+      return tag_name, attributes
+    end
+    # Merge attributes into base_attributes, with special care for `class:`
+    def merge_attrs(base_attributes, attributes)
+      base_class = base_attributes[:class]
+      more_class = attributes[:class]
+      merged_class = if base_class && more_class
+                       base_class + " " + more_class
+                     else
+                       base_class || more_class
+                     end
+      if merged_class
+        base_attributes.merge(attributes).merge(:class => merged_class)
+      else
+        base_attributes.merge(attributes)
+      end
+    end
+    def render_children(content=nil, block=nil)
+      case
+      when content && block
+        raise ArgumentError, "o cannot take both content and block"
+      when content
+        [content.to_s]
+      when block
+        @vdom_tree.push []
+        block_value = block.call
+        results = @vdom_tree.pop
+        if results.length > 0
+          results
+        else
+          # When 'o' is never called in the child block, use the last value
+          # eg.
+          #   o 'span' do
+          #     'Hello'  #=> This will be the content of the span tag
+          #   end
+          [block_value]
+        end
+      else
+        []
+      end
+    end
+    def render_component(comp_class, args, children)
+      comp = comp_class.new(@wired_actions)
+      render_args = {state: @current_state}.merge(args)
+      return comp.do_render(**render_args){ children }
+    end
+    def render_tag(tag_name, attributes, children)
+      js_attributes = Component.hash_to_js_obj(attributes || {})
+      if (style = attributes['style'])
+        `js_attributes.style = #{Component.hash_to_js_obj(style)}`
+      end
+      children ||= `null`
+      ret = %x{
+        {
+          nodeName: tag_name,
+          attributes: js_attributes,
+          children: children,
+          key: js_attributes.key
+        }
+      }
+      ret
+    end
+  end
+end

data/lib/ovto/fetch.rb ADDED Viewed

@@ -0,0 +1,53 @@
+require 'promise'
+require 'native'
+require 'json'
+module Ovto
+  # Wrapper for the fetch API
+  # The server must respond a json text.
+  #
+  # Example:
+  #   Ovto.fetch('/api/new_task', 'POST', {title: "do something"}){|json_data|
+  #     p json_data
+  #   }.fail{|e|  # Network error, 404 Not Found, JSON parse error, etc.
+  #     p e
+  #   }
+  def self.fetch(url, method='GET', data=nil)
+    init = `{
+      method: #{method},
+      credentials: 'same-origin' // Send cookies to the server (eg. for CookieStore of Rails)
+    }`
+    if method != 'GET'
+      %x{
+        var headers = {'Content-Type': 'application/json'};
+        var metaTag = document.querySelector('meta[name=csrf-token]');
+        if (metaTag) headers['X-CSRF-Token'] = metaTag.content;
+        init['headers'] = headers;
+        init['body'] = #{data.to_json};
+      }
+    end
+    return _do_fetch(url, init)
+  end
+  # Create an Opal Promise to call fetch API
+  def self._do_fetch(url, init)
+    promise = Promise.new
+    text = error = nil
+    %x{
+      fetch(url, init).then(response => {
+        if (response.ok) {
+          return response.text();
+        }
+        else {
+          throw response;
+        }
+      }).then(text =>
+        #{promise.resolve(JSON.parse(text))}
+      ).catch(error =>
+        #{promise.reject(error)}
+      );
+    }
+    return promise
+  end
+end