cuba-tools 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6086b272172c453acebdc0248bffa788e581a7b
-  data.tar.gz: 6710dda1e36ea1c6dca8167ea232b97a055d3a13
+  metadata.gz: 3bdced9844636ce9756c972e1f896b803385065d
+  data.tar.gz: f05797ab1125e08880e094778755aba92adcba0c
 SHA512:
-  metadata.gz: 255ec5eb229ccb8683a7a80addcf50a7e7668b4863feeef219483d49c0d34951326a89f90e1b8b4a4858af948c7603abc7cfcec9882152de719baba9542d1379
-  data.tar.gz: 920d17c304443ce6fd5d86d7ee9a941c6f8745fe7c0a0ff7843075696d4e30a8e9d54d5cc37ccfcc8e576c4643b2438440b834053188d9247c20ee93d458cddb
+  metadata.gz: 61784850e3b6ae80d5f523a168845266f3c9d4d7c84a637a8d2a819303f3931e6e74c6f8df7243be20a4408f8a5a088a4c7f6a68975f744fb3ab89f3e037320c
+  data.tar.gz: 4920a0e969a0a36e689ca97a6007c70d31865f66ed5e940a8b04c7e51db36ea76cea3aaa996adf328c7c31f7e0847eb7220d7a86cf167dc3e8d7fd788a2f11f8

data/cuba-tools.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "cuba-tools"
-  spec.version       = "0.0.2"
+  spec.version       = "0.0.3"
   spec.authors       = ["cj"]
   spec.email         = ["cjlazell@gmail.com"]
   spec.description   = %q{Contains a group of tools to extend cuba}
@@ -20,7 +20,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency "cuba", "~> 3.1.1"
   spec.add_dependency "shield", "~> 2.1.0"
   spec.add_dependency "signature-acd", "~> 0.1.9"
+  spec.add_dependency "mab", "~> 0.0.3"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "cutest-cj"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "tilt"
+  spec.add_development_dependency "slim"
 end

data/lib/cuba/tools/auth.rb

@@ -63,7 +63,7 @@ module Cuba::Tools
         if !defined? Devise
           require 'shield'
           app.plugin Shield::Helpers
-          app.use Shield::Middleware, "/login"
+          # app.use Shield::Middleware, "/login"
         else
           require 'warden'
           require 'devise'

data/lib/cuba/tools/inflectors.rb

@@ -0,0 +1,59 @@
+require 'ostruct'
+
+class String
+  def underscore
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr(" ", "_").
+    tr("-", "_").
+    downcase
+  end
+end
+
+class Object
+  def blank?
+    respond_to?(:empty?) ? empty? : !self
+  end
+
+  def present?
+    !blank?
+  end
+end
+
+class DeepOpenStruct < OpenStruct
+  def initialize(hash=nil)
+
+    @table = {}
+    @hash_table = {}
+
+    if hash
+      hash.each do |k,v|
+
+        if v.is_a?(Array)
+          other = Array.new()
+          v.each { | entry |
+            other.push(self.class.new(entry))
+          }
+          v = other
+        end
+
+        @table[k.to_sym] = (v.is_a?(Hash) ? self.class.new(v) : v)
+        @hash_table[k.to_sym] = v
+        new_ostruct_member(k)
+
+      end
+    end
+  end
+
+  def to_h
+    @hash_table
+  end
+end
+
+class Hash
+  def to_deep_ostruct
+    DeepOpenStruct.new self
+  end
+end
+

data/lib/cuba/tools/mab.rb

@@ -0,0 +1,5 @@
+require 'mab'
+
+def mab(&blk)
+  Mab::Builder.new({}, self, &blk).to_s
+end

data/lib/cuba/tools/widget/base.rb

@@ -0,0 +1,163 @@
+module Cuba::Tools
+  module Widget
+    class Base
+      JS_ESCAPE     = { '\\' => '\\\\', '</' => '<\/', "\r\n" => '\n', "\n" => '\n', "\r" => '\n', '"' => '\\"', "'" => "\\'" }
+      PARTIAL_REGEX = Regexp.new '([a-zA-Z_]+)$'
+      VIEW_TYPES    = %w(slim erb haml)
+
+      attr_accessor :app, :res, :req, :name, :events, :widget_state
+
+      def initialize app, res, req, name, events
+        @app          = app
+        @res          = res
+        @req          = req
+        @name         = name.to_s
+        @events       = events
+        @widget_state = false
+
+        events.add_observer self, :trigger
+      end
+
+      def set_state state
+        @widget_state = state
+      end
+
+      def reset_state
+        @widget_state = false
+      end
+
+      def render_state options = {}
+        if method(widget_state).parameters.length > 0
+          send(widget_state, options.to_deep_ostruct)
+        else
+          send(widget_state)
+        end
+      end
+
+      def trigger 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 == name or
+                opts[:for].to_s == widget_name
+            )
+              if not opts[:with]
+                e = widget_event
+              else
+                e = opts[:with]
+              end
+
+              if method(e) and method(e).parameters.length > 0
+                send(e, data)
+              else
+                send(e)
+              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('/')
+
+        # check for the extension
+        file = false
+        VIEW_TYPES.each do |type|
+          file = "#{view_path}/#{view_folder}/#{view}.#{type}"
+          if File.file? file
+            break
+          else
+            file = false
+          end
+        end
+
+        app.render file, locals
+      end
+
+      def partial template, locals = {}
+        locals[:partial] = template
+        render locals
+      end
+
+      def current_user
+        app.current_user
+      end
+
+      def view_path
+        Widget.config.view_path
+      end
+
+      def replace state, opts = {}
+        set_state state
+
+        if !state.is_a? String
+          opts[:state] = state
+          content = render_state, opts
+          selector = '#' + id_for(state)
+        else
+          if !opts.key?(:content) and !opts.key?(:with)
+            content = render_state opts
+          else
+            content = opts[:content] || opts[:with]
+          end
+          selector = state
+        end
+
+        reset_state
+
+        res.write '$("' + selector + '").replaceWith("' + escape(content) + '");'
+        # scroll to the top of the page just as if we went to the url directly
+        # if opts[:scroll_to_top]
+        #   res.write 'window.scrollTo(0, 0);'
+        # end
+      end
+
+      def id_for state
+        "#{req.env[:widget_name]}_#{state}"
+      end
+
+      def escape js
+        js.to_s.gsub(/(\\|<\/|\r\n|\\3342\\2200\\2250|[\n\r"'])/) {|match| JS_ESCAPE[match] }
+      end
+
+      class << self
+        attr_accessor :events, :available_helper_methods
+
+        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
+end

data/lib/cuba/tools/widget/events.rb

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

data/lib/cuba/tools/widget/helpers.rb

@@ -0,0 +1,76 @@
+module Cuba::Tools
+  module Widget
+    module Helpers
+      def self.setup app
+        require 'cuba/tools/mab'
+        # load up all the widgets if we have a path
+        if path = Widget.config.view_path
+          Dir["#{path}/**/*.rb"].each  { |rb| require rb  }
+        end
+      end
+
+      def method_missing(meth, *args, &block)
+        widget = req.env[:loaded_widgets][req.env[:widget_name].to_sym]
+
+        if widget and widget.respond_to? meth
+          widget.send meth, *args, &block
+        else
+          super
+        end
+      end
+
+      def widget_div opts = {}, &block
+        defaults = {
+          id: "#{req.env[:widget_name]}_#{req.env[:widget_state]}"
+        }.merge opts
+
+        name   = req.env[:widget_name].to_sym
+        widget = req.env[:loaded_widgets][name]
+
+        html = block.call widget
+
+        mab do
+          div(defaults) do
+            text! html
+          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]
+
+        if widget.method(state).parameters.length > 0
+          widget.send state, opts.to_deep_ostruct
+        else
+          widget.send state
+        end
+      end
+
+      def url_for_event event, options = {}
+        widget_name = options.delete(:widget_name) || req.env[:widget_name]
+        "http#{req.env['SERVER_PORT'] == '443' ? 's' : ''}://#{req.env['HTTP_HOST']}#{Widget.config.url_path}?widget_event=#{event}&widget_name=#{widget_name}" + (options.any?? '&' + URI.encode_www_form(options) : '')
+      end
+
+      def render_widgets
+        res.headers["Content-Type"] = "text/javascript; charset=utf-8"
+        widget_name, widget_event, events = Widget.load_all self, req, res
+        events.trigger widget_name, widget_event, req.params
+        # res.write "$('head > meta[name=csrf-token]').attr('content', '#{csrf_token}');"
+        res.write '$(document).trigger("page:change");'
+      end
+    end
+  end
+end

data/lib/cuba/tools/widget/middleware.rb

@@ -0,0 +1,14 @@
+module Cuba::Tools
+  module Widget
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        responder = Responder.new(@app, env)
+        responder.respond
+      end
+    end
+  end
+end

data/lib/cuba/tools/widget/responder.rb

@@ -0,0 +1,52 @@
+module Cuba::Tools
+  module Widget
+    class Responder
+      def initialize(app, env)
+        @app = app
+        @env = env
+      end
+
+      def respond
+        if widget_path
+          widget_name, widget_event, events = Widget.load_all @app, req, res
+
+          events.trigger widget_name, widget_event, req.params
+          # res.write "$('head > meta[name=csrf-token]').attr('content', '#{csrf_token}');"
+          res.write '$(document).trigger("page:change");'
+        end
+
+        res.finish
+      end
+
+      private
+
+      def req
+        @req ||= Rack::Request.new(@env)
+      end
+
+      def res
+        @res ||= begin
+          if not widget_path
+            status, headers, body = @app.call(req.env)
+          else
+            status, headers, body = [
+              200,
+              {"Content-Type" => "text/javascript; charset=utf-8"},
+              [""]
+            ]
+          end
+
+          Rack::Response.new(body, status, headers)
+        end
+      end
+
+      def widget_path
+        path[Regexp.new("^#{Widget.config.url_path}($|\\?.*)")]
+      end
+
+      def path
+        @env['PATH_INFO']
+      end
+    end
+  end
+end

data/lib/cuba/tools/widget.rb

@@ -0,0 +1,49 @@
+module Cuba::Tools
+  module Widget
+    autoload :Responder,  "cuba/tools/widget/responder"
+    autoload :Middleware, "cuba/tools/widget/middleware"
+    autoload :Helpers,    "cuba/tools/widget/helpers"
+    autoload :Base,       "cuba/tools/widget/base"
+    autoload :Events,     "cuba/tools/widget/events"
+
+    extend self
+
+    attr_accessor :config, :reset_config, :load_all
+
+    def setup
+      yield config
+    end
+
+    def config
+      @config || reset_config!
+    end
+
+    # Resets the configuration to the default (empty hash)
+    def reset_config!
+      @config = OpenStruct.new({
+        url_path: '/widgets',
+        widgets: {}
+      })
+    end
+
+    def load_all app, req, res
+      events = Events.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] ||= {}
+
+        Widget.config.widgets.each do |name, widget|
+          req.env[:loaded_widgets][name] = Object.const_get(widget).new(
+            app, res, req, name, events
+          )
+        end
+      end
+
+      [widget_name, widget_event, events]
+    end
+  end
+end

data/lib/cuba/tools.rb

@@ -1,3 +1,7 @@
+require 'cuba/tools/inflectors'
+
 module Cuba::Tools
-  autoload :Auth, "cuba/tools/auth"
+  autoload :Auth,   "cuba/tools/auth"
+  autoload :Api,    "cuba/tools/api"
+  autoload :Widget, "cuba/tools/widget"
 end

data/test/cutest_helper.rb

@@ -0,0 +1,4 @@
+require 'cuba'
+require 'cuba/tools'
+require 'pry'
+require 'awesome_print'

data/test/dummy/app/widgets/other_widget.rb

@@ -0,0 +1,7 @@
+class OtherWidget < Cuba::Tools::Widget::Base
+  respond_to :test, for: :some_widget, with: :some_test
+
+  def some_test
+    res.write 'cow'
+  end
+end

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

@@ -0,0 +1 @@
+| some partial

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

@@ -0,0 +1,6 @@
+= widget_div do |w|
+  = test_helper
+  #test display
+  = w.partial :some_partial
+  = w.render_state
+  = user_widget_method

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

@@ -0,0 +1,2 @@
+= widget_div do
+  | some state

data/test/dummy/app/widgets/some_widget.rb

@@ -0,0 +1,21 @@
+class SomeWidget < Cuba::Tools::Widget::Base
+  respond_to :test
+
+  def display
+    set_state :some_state
+
+    render
+  end
+
+  def some_state
+    render
+  end
+
+  def test
+    res.write 'moo'
+  end
+
+  def user_widget_method
+    'user_widget_method'
+  end
+end

data/test/tools/widget_test.rb

@@ -0,0 +1,102 @@
+require_relative '../cutest_helper'
+require "slim"
+require "cuba/render"
+require 'cgi'
+
+setup do
+  Cuba.reset!
+  Cuba::Tools::Widget.reset_config!
+  Cuba::Tools::Widget.setup do |c|
+    c.widgets = {
+      some_widget: 'SomeWidget',
+      other_widget: 'OtherWidget'
+    }
+    c.view_path = Dir.pwd + '/test/dummy/app/widgets'
+  end
+  Cuba.use Cuba::Tools::Widget::Middleware
+  Cuba.plugin Cuba::Tools::Widget::Helpers
+  Cuba.plugin Cuba::Render
+  Cuba.define do
+    def test_helper
+      'test_helper'
+    end
+
+    on "test" do
+      res.write render_widget :some_widget
+    end
+
+    on root do
+      res.write 'default'
+    end
+  end
+end
+
+scope "tools/widget" do
+  test "config" do
+    assert Cuba::Tools::Widget.config.url_path == '/widgets'
+    Cuba::Tools::Widget.setup do |config|
+      config.url_path = '/new'
+    end
+    assert Cuba::Tools::Widget.config.url_path == '/new'
+  end
+end
+
+scope "cuba/tools/widget/middleware" do
+  test 'default' do
+    status, headers, resp = Cuba.call({
+      'PATH_INFO' => '/widgets',
+      'rack.input'     => {}
+    })
+    body = resp.send('body').join
+
+    assert status == 200
+    assert headers['Content-Type'] == "text/javascript; charset=utf-8"
+    assert body[/\$\(document\)/] != nil
+    assert body[/default/] == nil
+
+    _, _, resp = Cuba.call({
+      'PATH_INFO' => '/',
+      'rack.input'     => {}
+    })
+    body = resp.send('body').join
+
+    assert body[/\$\(document\)/] == nil
+    assert body[/default/] != nil
+  end
+
+  test 'widget events' do
+    _, _, resp = Cuba.call({
+      'PATH_INFO'   => '/widgets',
+      'REQUEST_METHOD' => 'GET',
+      'rack.input'     => {},
+      'QUERY_STRING'   => 'widget_name=some_widget&widget_event=test'
+    })
+    body = CGI.unescapeHTML resp.send('body').join
+
+    assert body[/moo/] != nil
+    assert body[/cow/] != nil
+  end
+
+  test '#render_widget' do
+    _, _, resp = Cuba.call({
+      'PATH_INFO'   => '/test',
+      'SCRIPT_NAME'   => '/test',
+      'REQUEST_METHOD' => 'GET',
+      'rack.input'     => {}
+    })
+    # TODO: figure out why the html isn't decoded properly
+    # body = CGI.unescapeHTML resp.send('body').join
+    body = resp.send('body').join
+
+    assert body['test_helper'] != nil
+    assert body['display'] != nil
+    assert body['some_widget_display'] != nil
+    assert body['some partial'] != nil
+    assert body['some state'] != nil
+    assert body['user_widget_method'] != nil
+    # TODO: figure out why the html isn't decoded properly
+    # and this is failing
+    # assert body['id="some_widget_some_state"'] != nil
+    assert body['some_widget_some_state'] != nil
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuba-tools
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - cj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-20 00:00:00.000000000 Z
+date: 2014-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cuba
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.9
+- !ruby/object:Gem::Dependency
+  name: mab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: cutest-cj
+  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'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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'
+- !ruby/object:Gem::Dependency
+  name: tilt
+  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'
+- !ruby/object:Gem::Dependency
+  name: slim
+  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: Contains a group of tools to extend cuba
 email:
 - cjlazell@gmail.com
@@ -96,6 +166,21 @@ files:
 - lib/cuba/tools.rb
 - lib/cuba/tools/api.rb
 - lib/cuba/tools/auth.rb
+- lib/cuba/tools/inflectors.rb
+- lib/cuba/tools/mab.rb
+- lib/cuba/tools/widget.rb
+- lib/cuba/tools/widget/base.rb
+- lib/cuba/tools/widget/events.rb
+- lib/cuba/tools/widget/helpers.rb
+- lib/cuba/tools/widget/middleware.rb
+- lib/cuba/tools/widget/responder.rb
+- test/cutest_helper.rb
+- test/dummy/app/widgets/other_widget.rb
+- test/dummy/app/widgets/some_widget.rb
+- test/dummy/app/widgets/some_widget/_some_partial.slim
+- test/dummy/app/widgets/some_widget/display.slim
+- test/dummy/app/widgets/some_widget/some_state.slim
+- test/tools/widget_test.rb
 homepage: ''
 licenses:
 - MIT
@@ -120,4 +205,11 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Tools to extend cuba
-test_files: []
+test_files:
+- test/cutest_helper.rb
+- test/dummy/app/widgets/other_widget.rb
+- test/dummy/app/widgets/some_widget.rb
+- test/dummy/app/widgets/some_widget/_some_partial.slim
+- test/dummy/app/widgets/some_widget/display.slim
+- test/dummy/app/widgets/some_widget/some_state.slim
+- test/tools/widget_test.rb