dominate 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb406d2542020af78ec7fa5410828484f54663ae
-  data.tar.gz: e1931bd044daecb7c27bd0f48a573eaa1503c86b
+  metadata.gz: 002723ab44811ed63d9c1288531e1ac92eb3a0f5
+  data.tar.gz: 6c7eaaad47a20ba8274b9beb91ee0945e111b315
 SHA512:
-  metadata.gz: 3560002bf681a6f8e3dd19fccd84c04df20c9939669334066475fbb45e118698ffff7e74999db60fd63e6848d44ae61abb08176fe3d2313a033d3267143eafb6
-  data.tar.gz: 3961637f04483f8990e2320e333cc2eb7f7c4936e0914399821ee365bfa843b7bdaa335d85176d4f451cf15b6e82a940f45ea3ae65d2968de5603a154bc5641f
+  metadata.gz: f9f9c264fa9524b3474f45f4dee0460bc6ec316602908af12cc76d9ff1a7fcd0d7ae4eb7dbc8b3cfe674b1e54841ba288261408b9a51f6ac86d3b42ed66adea5
+  data.tar.gz: e30b012604baebe274ff73e3a885a7be5d39f05bc063303dce4409d69da38803bf18d27fc355a5454f3b0425fc89678325b6bef8b5fb4d0a87176fce0cadb252

data/dominate.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_development_dependency "awesome_print"
   spec.add_development_dependency "slim"
+  spec.add_development_dependency "cuba"
 end

data/lib/dominate/dom.rb

@@ -73,7 +73,11 @@ module Dominate
     private
 
     def set_doc html
-      @doc = Nokogiri::HTML.parse html
+      if html.match(/<html.*>/)
+        @doc = Nokogiri::HTML::Document.parse html
+      else
+        @doc = Nokogiri::HTML.fragment html
+      end
     end
 
     def reset_html

data/lib/dominate/html.rb

@@ -21,15 +21,20 @@ module Dominate
       html = false
 
       VIEW_TYPES.each do |type|
-        file = "#{path}.#{type}"
+        f = "#{path}.#{type}"
 
-        if File.file? file
-          template = Tilt.new file
+        if File.file? f
+          template = Tilt.new f
           html     = template.render Instance.new(instance, config)
           break
         end
       end
 
+      unless html
+        raise Dominate::NoFileFound,
+          "Could't find file: #{path} with any of these extensions: #{VIEW_TYPES.join(', ')}."
+      end
+
       html
     end
   end

data/lib/dominate/instance.rb

@@ -13,11 +13,11 @@ module Dominate
 
     def method_missing method, *args, &block
       if @__config__.respond_to? method
-        @__config__.send method
-      elsif @__instance__.respond_to? method
-        @__instance__.send method
+        @__config__.send method, *args, &block
+      elsif @__instance__.respond_to? method, *args, &block
+        @__instance__.send method, *args, &block
       else
-        super
+        @__instance__.send 'method_missing', method, *args, &block
       end
     end
   end

data/lib/dominate/version.rb

@@ -1,3 +1,3 @@
 module Dominate
-  VERSION = "0.5.2"
+  VERSION = "0.6.0"
 end

data/lib/dominate/widget/event.rb

@@ -0,0 +1,17 @@
+require "observer"
+
+module Dominate
+  class Widget
+    class Event < Struct.new(:res, :req)
+      include Observable
+
+      def trigger widget_name, widget_event, data = {}
+        # THIS IS WHAT WILL MAKE SURE EVENTS ARE TRIGGERED
+        changed
+        ##################################################
+
+        notify_observers widget_name, widget_event, data.to_deep_ostruct
+      end
+    end
+  end
+end

data/lib/dominate/widget/helper.rb

@@ -0,0 +1,58 @@
+module Dominate
+  class Widget
+    module Helper
+      class << self
+        def setup app
+          initialize
+        end
+
+        def initialize
+          # Load the widgets
+          Dir.glob("#{Dominate.config.widget_path}/**/*.rb").each do |w|
+            require w
+          end
+
+          if defined?(Slim) && defined?(Slim::Engine)
+            Slim::Engine.set_default_options \
+              disable_escape: true,
+              use_html_safe: false,
+              disable_capture: false
+          end
+        end
+      end
+
+      def render_widget *args
+        Widget.load_all(self, req, res)
+
+        if args.first.kind_of? Hash
+          opts = args.first
+          name = req.env[:widget_name]
+        else
+          name = args.first
+          opts = args.length > 1 ? args.last : {}
+        end
+
+        # set the current state (the method that will get called on render_widget)
+        state = opts[:state] || 'display'
+
+        widget = req.env[:loaded_widgets][name]
+
+        # begin
+          if widget.method(state).parameters.length > 0
+            resp = widget.send state, opts.to_deep_ostruct
+          else
+            resp = widget.send state
+          end
+
+          if resp.is_a? Dominate::Dom
+            resp.html
+          else
+            resp
+          end
+        # rescue NoMethodError
+        #   raise "Please add ##{state} to #{widget.class}."
+        # end
+      end
+    end
+  end
+end

data/lib/dominate/widget/middleware.rb

@@ -0,0 +1,49 @@
+module Dominate
+  class Widget
+    class Middleware
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        @env = env
+
+        if widget_path
+          widget_name, widget_event, event = Widget.load_all @app, req, res
+
+          event.trigger widget_name, widget_event, req.params
+          # res.write "$('head > meta[name=csrf-token]').attr('content', '#{csrf_token}');"
+          res.write '$(document).trigger("page:change");'
+          res.finish
+        else
+          res
+        end
+      end
+
+      private
+
+      def res
+        @res ||= begin
+          if not widget_path
+            @app.call(req.env)
+          else
+            Cuba::Response.new
+          end
+        end
+      end
+
+      def req
+        @req ||= Rack::Request.new(@env)
+      end
+
+      def widget_path
+        path[Regexp.new("^#{Dominate.config.widget_url}($|\\?.*)")]
+      end
+
+      def path
+        @env['PATH_INFO']
+      end
+    end
+  end
+end

data/lib/dominate/widget.rb

@@ -0,0 +1,152 @@
+module Dominate
+  class Widget
+    JS_ESCAPE     = { '\\' => '\\\\', '</' => '<\/', "\r\n" => '\n', "\n" => '\n', "\r" => '\n', '"' => '\\"', "'" => "\\'" }
+    PARTIAL_REGEX = Regexp.new '([a-zA-Z_]+)$'
+
+    autoload :Event,      "dominate/widget/event"
+    autoload :Middleware, "dominate/widget/middleware"
+    autoload :Helper,     "dominate/widget/helper"
+
+    attr_accessor :app, :res, :req, :name, :event, :widget_state
+
+    def initialize app, res, req, name, event
+      @app          = app
+      @res          = res
+      @req          = req
+      @name         = name.to_s
+      @event        = event
+      @widget_state = false
+
+      event.add_observer self, :trigger_event
+    end
+
+    def method_missing method, *args, &block
+      if app.respond_to? method
+        self.instance_variables.each do |name|
+          app.instance_variable_set name, self.instance_variable_get(name)
+        end
+
+        app.send method, *args, &block
+      else
+        super
+      end
+    end
+
+    def trigger widget_event, data = {}
+      widget_name = data.delete(:for)
+
+      req.env[:loaded_widgets].each do |n, w|
+        w.trigger_event (widget_name || req.params['widget_name']), widget_event,
+          data.to_deep_ostruct
+      end
+    end
+
+    def trigger_event widget_name, widget_event, data = {}
+      if class_events = self.class.events
+        class_events.each do |class_event, opts|
+          if class_event.to_s == widget_event.to_s && (
+            widget_name.to_s == name or
+            opts[:for].to_s == widget_name.to_s
+          )
+            if not opts[:with]
+              e = widget_event
+            else
+              e = opts[:with]
+            end
+
+            # begin
+              if method(e) and method(e).parameters.length > 0
+                resp = send(e, data)
+              else
+                resp = send(e)
+              end
+
+              if resp.is_a? Dominate::Dom
+                res.write resp.html
+              else
+                resp
+              end
+            # rescue NoMethodError
+            #   raise "Please add ##{e} to your #{self.class}."
+            # end
+          end
+        end
+      end
+    end
+
+    def render *args
+      if args.first.kind_of? Hash
+        locals = args.first
+        # if it's a partial we add an underscore infront of it
+        state = view = locals[:state] ||
+          "#{locals[:partial]}".gsub(PARTIAL_REGEX, '_\1')
+      else
+        state = view = args.first
+        locals = args.length > 1 ? args.last : {}
+      end
+
+      # set the state and view if it's blank
+      if view.blank?
+        state = view = caller[0][/`.*'/][1..-2]
+      # override state if widget_state set
+      elsif !locals[:state] && widget_state
+        state = widget_state
+      end
+
+      req.env[:widget_name]  = name
+      req.env[:widget_state] = state
+
+      view_folder = self.class.to_s.gsub(
+        /\w+::Widgets::/, ''
+      ).split('::').map(&:underscore).join('/')
+
+      # set the view path to the widget path
+      locals[:view_path] = view_path
+      # we also don't want a layout
+      locals[:layout] = false unless locals.key? :layout
+      file = "#{view_folder}/#{view}"
+
+      Dominate::HTML.file(file, self, locals)
+    end
+
+    def view_path
+      Dominate.config.widget_path
+    end
+
+    class << self
+      attr_accessor :events
+
+      def load_all app, req, res
+        event = Event.new res, req
+
+        if widget_event = req.params["widget_event"]
+          widget_name = req.params["widget_name"]
+        end
+
+        unless req.env[:loaded_widgets]
+          req.env[:loaded_widgets] ||= {}
+
+          Dominate.config.widgets.each do |name, widget|
+            req.env[:loaded_widgets][name] = Object.const_get(widget).new(
+              app, res, req, name, event
+            )
+          end
+        end
+
+        [widget_name, widget_event, event]
+      end
+
+      def respond_to event, opts = {}
+        @events ||= []
+        @events << [event.to_s, opts]
+      end
+
+      def responds_to *events
+        @events ||= []
+        events.each do |event|
+          @events << [event, {}]
+        end
+      end
+    end
+  end
+end

data/lib/dominate.rb

@@ -11,7 +11,9 @@ module Dominate
   autoload :HTML,     "dominate/html"
   autoload :Scope,    "dominate/scope"
   autoload :Dom,      "dominate/dom"
+  autoload :Widget,   "dominate/widget"
 
+  class NoFileFound < StandardError; end
 
   attr_accessor :config, :reset_config
 
@@ -27,7 +29,10 @@ module Dominate
   def reset_config!
     @config = OpenStruct.new({
       view_path:   './views',
-      layout:      'app'
+      layout:      'app',
+      widget_path: './widgets',
+      widget_url:  '/widgets',
+      widgets:     {}
     })
   end
 

data/test/dummy/widgets/other_widget.rb

@@ -0,0 +1,11 @@
+class OtherWidget < Dominate::Widget
+  respond_to :test, for: :some_widget, with: :some_widget_test
+
+  def display
+    render
+  end
+
+  def some_widget_test
+    res.write 'cow'
+  end
+end

data/test/dummy/widgets/some_widget/display.slim

@@ -0,0 +1,3 @@
+h1
+  | Hello, #{@var}
+= hello

data/test/dummy/widgets/some_widget/test.slim

@@ -0,0 +1,2 @@
+| moo
+= render_widget :some_widget

data/test/dummy/widgets/some_widget.rb

@@ -0,0 +1,17 @@
+class SomeWidget < Dominate::Widget
+  respond_to :test
+
+  def display
+    @var = 'World!'
+
+    render
+  end
+
+  def test data
+    render
+  end
+
+  def hello
+    "Hello, World!"
+  end
+end

data/test/helper.rb

@@ -1,2 +1,4 @@
+require 'dominate'
+require 'slim'
 require 'pry'
 require 'awesome_print'

data/test/{dominate_test.rb → template_test.rb}

@@ -1,6 +1,4 @@
 require_relative 'helper'
-require 'dominate'
-require 'slim'
 
 setup do
   Dominate.reset_config!
@@ -24,7 +22,7 @@ setup do
   })
 end
 
-scope 'dominate' do
+scope 'dominate template' do
   test 'html' do |a|
     assert a.dom.html['test']
     assert a.dom.html.scan(/<a.*>/).length == 2
@@ -114,4 +112,10 @@ scope 'dominate' do
     assert dom.html['#000']
     assert dom.html['added via .dom file']
   end
+
+  test 'raise' do
+    assert_raise(Dominate::NoFileFound) do
+      Dominate::HTML.file 'no_file', false, name: '.dom'
+    end
+  end
 end

data/test/widget_test.rb

@@ -0,0 +1,50 @@
+require_relative 'helper'
+require 'cuba'
+
+setup do
+  Dominate.reset_config!
+  Dominate.setup do |c|
+    c.widget_path = './test/dummy/widgets'
+    c.widget_url  = '/widgets'
+    c.widgets = {
+      some_widget:  'SomeWidget',
+      other_widget: 'OtherWidget'
+    }
+  end
+
+  Cuba.reset!
+  Cuba.use Dominate::Widget::Middleware
+  Cuba.plugin Dominate::Widget::Helper
+  Cuba.define do
+    on "test" do
+      res.write render_widget :some_widget
+    end
+  end
+end
+
+scope 'dominate widget' do
+  test 'render_widget' do |a|
+    _, _, resp = Cuba.call({
+      'PATH_INFO'   => '/test',
+      'SCRIPT_NAME'   => '/test',
+      'REQUEST_METHOD' => 'GET',
+      'rack.input'     => {}
+    })
+
+    assert resp.join.scan('Hello, World!').length == 2
+  end
+
+  test 'event' do
+    _, _, resp = Cuba.call({
+      'PATH_INFO'   => '/widgets',
+      'REQUEST_METHOD' => 'GET',
+      'rack.input'     => {},
+      'QUERY_STRING'   => 'widget_name=some_widget&widget_event=test'
+    })
+    body = resp.join
+
+    assert body['Hello, World!']
+    assert body['moo']
+    assert body['cow']
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dominate
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - cj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-03 00:00:00.000000000 Z
+date: 2014-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: cuba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Allows you to manipulate the dom without touching it.
 email:
 - cjlazell@gmail.com
@@ -156,14 +170,23 @@ files:
 - lib/dominate/instance.rb
 - lib/dominate/scope.rb
 - lib/dominate/version.rb
-- test/dominate_test.rb
+- lib/dominate/widget.rb
+- lib/dominate/widget/event.rb
+- lib/dominate/widget/helper.rb
+- lib/dominate/widget/middleware.rb
 - test/dummy/app.slim
 - test/dummy/flat.dom
 - test/dummy/flat.slim
 - test/dummy/footer.slim
 - test/dummy/header.html
 - test/dummy/index.html
+- test/dummy/widgets/other_widget.rb
+- test/dummy/widgets/some_widget.rb
+- test/dummy/widgets/some_widget/display.slim
+- test/dummy/widgets/some_widget/test.slim
 - test/helper.rb
+- test/template_test.rb
+- test/widget_test.rb
 homepage: ''
 licenses:
 - MIT
@@ -189,11 +212,16 @@ signing_key:
 specification_version: 4
 summary: Templating Engine.
 test_files:
-- test/dominate_test.rb
 - test/dummy/app.slim
 - test/dummy/flat.dom
 - test/dummy/flat.slim
 - test/dummy/footer.slim
 - test/dummy/header.html
 - test/dummy/index.html
+- test/dummy/widgets/other_widget.rb
+- test/dummy/widgets/some_widget.rb
+- test/dummy/widgets/some_widget/display.slim
+- test/dummy/widgets/some_widget/test.slim
 - test/helper.rb
+- test/template_test.rb
+- test/widget_test.rb