RubyGems - opalla - Versions diffs - 0.1.0 → 0.1.1 - Mend

opalla 0.1.0 → 0.1.1

Files changed (29) hide show

checksums.yaml +4 -4
data/README.md +394 -14
data/lib/opalla.rb +11 -4
data/lib/opalla/component_helper.rb +28 -0
data/lib/opalla/controller_add_on.rb +11 -0
data/lib/opalla/engine.rb +27 -0
data/lib/opalla/middleware.rb +20 -0
data/lib/opalla/util.rb +63 -0
data/lib/opalla/version.rb +1 -1
data/lib/rails/generators/opalla/assets_generator.rb +23 -0
data/lib/rails/generators/opalla/collection_generator.rb +19 -0
data/lib/rails/generators/opalla/component_generator.rb +27 -0
data/lib/rails/generators/opalla/install_generator.rb +62 -0
data/lib/rails/generators/opalla/model_generator.rb +19 -0
data/opal/collection.rb +71 -0
data/opal/component.rb +136 -0
data/opal/controller.rb +60 -0
data/opal/diffDOM.js +1371 -0
data/opal/diff_dom.rb +26 -0
data/opal/element.rb +17 -0
data/opal/hex_random.rb +12 -0
data/opal/model.rb +50 -0
data/opal/opalla.rb +21 -0
data/opal/router.rb +66 -0
data/opal/sha1.js +366 -0
data/opal/view_helper.rb +168 -0
data/opalla.gemspec +8 -0
data/opalla.gif +0 -0
metadata +109 -2

data/lib/opalla/component_helper.rb ADDED

@@ -0,0 +1,28 @@
+module Opalla
+  module ComponentHelper
+    def component(name, id: nil, model: nil, collection: nil)
+      comp_id = (id || "#{name}-#{cidn_and_increment}")
+      html    = component_html(name, id: id, model: model, collection: collection)
+      output  = Nokogiri::HTML.fragment(html).children.attr(id: comp_id).to_s
+      output.html_safe
+    end
+    protected
+    def component_html(name, id: nil, model: nil, collection: nil)
+      options = { partial: "components/#{name}", locals: {} }
+      model.nil?      || options[:locals][:model]      = model
+      collection.nil? || options[:locals][:collection] = collection
+      render(options)
+    end
+    def cidn
+      @cidn ||= 0
+    end
+    def cidn_and_increment
+      @cidn = cidn + 1
+      @cidn - 1
+    end
+  end
+end

data/lib/opalla/controller_add_on.rb ADDED

@@ -0,0 +1,11 @@
+module Opalla
+  module ControllerAddOn
+    def expose(variable_assignments)
+      Opalla::Util.add_vars(variable_assignments)
+      variable_assignments.each do |key, value|
+        define_singleton_method(key){ value }
+        self.class.helper_method key
+      end
+    end
+  end
+end

data/lib/opalla/engine.rb ADDED

@@ -0,0 +1,27 @@
+require 'rails'
+module Opalla
+  class Engine < ::Rails::Engine
+    config.before_configuration do |app|
+      config.app_generators.javascript_engine :opalla
+      app.middleware.use OpallaMiddleware
+      js_folder = app.root.join(*%w[app assets javascripts]).to_s
+      app.config.autoload_paths += ["#{js_folder}/lib"]
+      app.config.autoload_paths += ["#{js_folder}/models"]
+      app.config.autoload_paths += ["#{js_folder}/collections"]
+      Opal.append_path File.expand_path('../../../opal', __FILE__)
+    end
+    ActiveSupport.on_load(:action_view) do
+      include Opalla::ComponentHelper
+    end
+    ActiveSupport.on_load(:action_controller) do
+      include Opalla::ControllerAddOn
+    end
+    config.after_initialize do |app|
+      ActionController::Base.prepend_view_path "app/assets/javascripts/views/"
+    end
+  end
+end

data/lib/opalla/middleware.rb ADDED

@@ -0,0 +1,20 @@
+class OpallaMiddleware
+  def initialize(app)
+    @app = app
+  end
+  def call(env)
+    s, h, r = @app.call(env)
+    return [s, h, r] unless h['Content-Type'] =~ %r{text/html}
+    html = r.body.gsub("<body>", "<body>#{js_routes}")
+    [s, h, [html]]
+  end
+  def js_routes
+    <<~JS
+      <script>
+        window.opalla_data = #{ Opalla::Util.data_dump.to_json }
+      </script>
+    JS
+  end
+end

data/lib/opalla/util.rb ADDED

@@ -0,0 +1,63 @@
+require 'digest'
+module Opalla
+  module HexRandom
+    def self.[]
+      x = rand.to_s
+      y = Time.new.strftime("%S%L")
+      Digest::SHA1.hexdigest("#{y}#{x}")
+    end
+  end
+  module Util
+    class JsFormatter
+      def initialize
+        @buffer = []
+      end
+      def result
+        @buffer
+      end
+      def section(routes)
+        @buffer = routes.each_with_object({}) do |r, memo|
+          path = r[:path].gsub(/\(.:format\)/, '')
+          memo[r[:name]] = {
+            verb: r[:verb],
+            path: path,
+            reqs: r[:reqs]
+          }
+        end
+      end
+      def header(routes); end
+    end
+    class << self
+      def add_vars(var_assign)
+        @vars ||= {}
+        @vars.merge!(var_assign)
+      end
+      def vars
+        @vars || {}
+      end
+      def data_dump
+        Marshal.dump(data)
+      end
+      def data
+        {
+          routes: routes,
+          vars:   vars
+        }
+      end
+      def routes
+        all_routes = Rails.application.routes.routes
+        inspector  = ActionDispatch::Routing::RoutesInspector.new(all_routes)
+        inspector.format(JsFormatter.new)
+      end
+    end
+  end
+end

data/lib/opalla/version.rb CHANGED

@@ -1,3 +1,3 @@
 module Opalla
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/rails/generators/opalla/assets_generator.rb ADDED

@@ -0,0 +1,23 @@
+require 'rails/generators'
+module Opalla
+  class AssetsGenerator < Rails::Generators::NamedBase
+    def create_controller
+      create_file js("controllers/#{file_name}_controller.rb"), <<~CONTROLLER
+        class #{class_name}Controller < ApplicationController
+          # Write your actions here!
+        end
+      CONTROLLER
+    end
+    def create_view_folder
+      empty_directory js("views/#{file_name}")
+    end
+  protected
+    def js(path)
+      "app/assets/javascripts/#{path}"
+    end
+  end
+end

data/lib/rails/generators/opalla/collection_generator.rb ADDED

@@ -0,0 +1,19 @@
+require 'rails/generators'
+module Opalla
+  class CollectionGenerator < Rails::Generators::NamedBase
+    def create_collection
+      create_file js("collections/#{file_name}.rb"), <<~CONTROLLER
+        class #{class_name} < Opalla::Collection
+          # attr_reader :attrs
+        end
+      CONTROLLER
+    end
+  protected
+    def js(path)
+      "app/assets/javascripts/#{path}"
+    end
+  end
+end

data/lib/rails/generators/opalla/component_generator.rb ADDED

@@ -0,0 +1,27 @@
+require 'rails/generators'
+module Opalla
+  class ComponentGenerator < Rails::Generators::NamedBase
+    def create_component
+      create_file js("components/#{file_name}_component.rb"), <<~CONTROLLER
+        class #{class_name}Component < ApplicationComponent
+          # Feel free to write your component actions, bindings, events
+        end
+      CONTROLLER
+    end
+    def create_views
+      ext = defined?(Haml) ? 'haml' : 'erb'
+      create_file js("views/components/_#{file_name}.#{ext}"), <<~VIEW
+      .#{file_name.dasherize}
+        -# Component content
+      VIEW
+    end
+  protected
+    def js(path)
+      "app/assets/javascripts/#{path}"
+    end
+  end
+end

data/lib/rails/generators/opalla/install_generator.rb ADDED

@@ -0,0 +1,62 @@
+require 'rails/generators'
+module Opalla
+  class InstallGenerator < Rails::Generators::Base
+    desc 'Creates Opalla files'
+    def create_folders
+      %w[
+        components
+        controllers
+        lib
+        models
+        collections
+        views/components
+      ].each {|dir| empty_directory js(dir) }
+    end
+    def create_basic_files
+      create_file js('application.rb'), <<~APPLICATION
+        require 'opalla'
+        require_tree './lib'
+        require_tree './models'
+        require_tree './collections'
+        require_tree './components'
+        require_tree './controllers'
+        require_tree './views'
+        Document.ready? do
+          Opalla::Router.start
+        end
+      APPLICATION
+      delete_appjs = ask %q{
+        I've just created the main app file (application.rb)
+        Should I just delete your application.js, since you won't need it anymore?
+        (If you say no, please be sure to remove it later, ok?)
+        [Y/n]
+      }
+      remove_file(js('application.js')) if delete_appjs == 'Y'
+      create_file js('components/application_component.rb'), <<~COMPONENT
+        class ApplicationComponent < Opalla::Component
+          # Code shared between all components go here
+        end
+      COMPONENT
+      create_file js('controllers/application_controller.rb'), <<~CONTROLLER
+        class ApplicationController < Opalla::Controller
+          # Code shared between all controllers go here
+        end
+      CONTROLLER
+    end
+  protected
+    def js(path)
+      "app/assets/javascripts/#{path}"
+    end
+  end
+end

data/lib/rails/generators/opalla/model_generator.rb ADDED

@@ -0,0 +1,19 @@
+require 'rails/generators'
+module Opalla
+  class ModelGenerator < Rails::Generators::NamedBase
+    def create_component
+      create_file js("models/#{file_name}.rb"), <<~CONTROLLER
+        class #{class_name} < Opalla::Model
+          # attr_reader :attrs
+        end
+      CONTROLLER
+    end
+  protected
+    def js(path)
+      "app/assets/javascripts/#{path}"
+    end
+  end
+end

data/opal/collection.rb ADDED

@@ -0,0 +1,71 @@
+module Opalla
+  class Collection
+    attr_accessor :models
+    alias_method :all, :models
+    def initialize(models=nil)
+      @models = models || []
+    end
+    def create(options)
+      model_class.new(options)
+    end
+    def add(*attributes)
+      new_model = model_class.new(*attributes)
+      bindings.each {|b| new_model.bind(*b[:attributes], b[:callback])}
+      models << new_model
+      trigger_callbacks
+    end
+    def remove(arg)
+      case arg
+      when Element, Numeric, String then models.delete(find(arg))
+      else models.delete(arg)
+      end
+      trigger_callbacks
+    end
+    def find(arg)
+      case arg
+      when Numeric, String
+        models.each do |model|
+          return model if model.model_id == arg
+        end
+      when Element
+        sel = '[data-model-id]'
+        $console.log arg
+        if arg.is(sel)
+          find(arg)
+        else
+          find(arg.closest(sel).first.data('model-id'))
+        end
+      end
+    end
+    def bind(*attributes, callback)
+      @bindings ||= []
+      @bindings << { attributes: attributes, callback: callback }
+      models.each {|m| m.bind(*attributes, callback) }
+    end
+    def bindings
+      @bindings || []
+    end
+    def trigger_callbacks
+      callbacks.empty? && return
+      callbacks.each(&:call)
+    end
+    def callbacks
+      @bindings.map { |b| b[:callback] }
+    end
+    protected
+    def model_class
+      Object::const_get("#{self.class.to_s.singularize}")
+    end
+  end
+end

data/opal/component.rb ADDED

@@ -0,0 +1,136 @@
+module Opalla
+  class Component
+    include ViewHelper
+    attr_reader :template, :events, :model, :collection, :components, :id
+    def initialize(template: nil, model: nil, collection: nil, id: nil)
+      template  ||= "components/_#{component_name}"
+      @template   = Template["views/#{template}"]
+      @components = []
+      @id         = id
+      @resource   = @model = model unless model.nil?
+      @resource   = @collection = collection unless collection.nil?
+      register_bindings
+    end
+    def render
+      if @rendered.nil?
+        @rendered = true
+        html = Element[template.render(self)]
+        @id = id || cid(cidn_and_increment)
+        html.attr(:id, id)
+        html
+      else
+        target = Element[template.render(self)]
+        el.morph(target).attr(:id, id)
+        bind_events
+      end
+    end
+    def el
+      Element["##{id}"] if @rendered
+    end
+    def bind_events
+      remove_events
+      components.each &:bind_events
+      events_hash.nil? && return
+      events_hash.each do |caller, method|
+        event, selector = caller.split(' ', 2)
+        el.find(selector).on event do |e|
+          e.prevent
+          case method
+            when Symbol then send(method, e.element)
+            when Proc   then instance_exec(e.element, &method)
+          end
+        end
+      end
+    end
+    def remove_events
+      components.each &:remove_events
+      events_hash.nil? && return
+      events_hash.each do |caller, method|
+        event, selector = caller.split(' ', 2)
+        el.find(selector).off event
+      end
+    end
+    def component(name, options={})
+      comp = Object::const_get("#{name.camelize}Component").new(options)
+      @components << comp
+      comp.render
+    end
+  protected
+    def cidn
+      n = self.class.instance_variable_get(:"@cidn")
+      return(n) unless n.nil?
+      self.class.instance_variable_set(:"@cidn", 0)
+    end
+    def cid
+      "#{component_name}-#{cidn}"
+    end
+    def cidn_and_increment
+      self.class.instance_variable_set :"@cidn", cidn + 1
+      self.class.instance_variable_get(:"@cidn") - 1
+    end
+    def get_bindings
+      self.class.instance_variable_get :@bindings
+    end
+    def register_bindings
+      get_bindings.nil? && return
+      if !@model.nil?
+        bind_model
+      elsif !@collection.nil?
+        bind_collection
+      end
+      include_input_bindings
+    end
+    def include_input_bindings
+      merge_events_hash({
+        'input [data-bind]' => -> target do
+          model = @resource.find(target)
+          attr  = target.data('bind')
+          model.public_send(:"#{attr}=", target.value)
+        end
+      })
+    end
+    def component_name
+      self.class.to_s.underscore.gsub('_component', '')
+    end
+    def events_hash
+      self.class.instance_variable_get(:@events) || {}
+    end
+    def merge_events_hash(new_hash)
+      self.class.instance_variable_set(:@events, events_hash.merge(new_hash))
+    end
+    def self.events(events_hash)
+      @events = events_hash
+    end
+    def self.bind(*attributes)
+      @bindings = attributes
+    end
+    def bind_model
+      model.nil? && return
+      model.bind(*get_bindings, -> { render } )
+    end
+    def bind_collection
+      (collection.nil? || get_bindings.nil?) && return
+      collection.bind(*get_bindings, -> { render })
+    end
+  end
+end