roda-contrib 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb288c9a14fff9c8e20f4c634d98dbb978d16665
-  data.tar.gz: 1796bec3454a2debbebfb7fca336b7eae91877f5
+  metadata.gz: 02c8c0cc04c5707343034068120ae9b8ed70cf90
+  data.tar.gz: af47f15ba933ef6a3c0dc06219a6e1a0a1f2d7dd
 SHA512:
-  metadata.gz: dc3874788ae3fd3a0e937f7b45983993c07e600ab2da16158e929a7165d9f3ade248b774f200d4a4bee09845f52f6a5e09e0a951c68f86f46f6f5d1af7290c63
-  data.tar.gz: a392f95361ea4f3d54384f5f968a09d7200ca3bad051b5e942c07a3dc229414d715b39bac5708570e02b8b78eac38ba7c6236457ce91f577dd32155601b34905
+  metadata.gz: 309ecb8592c05a838d39658cfad67c1d121646cc64ad0d7c54ade11ce5fadfacfb395743ddffe38d76a4de02287a401488d40c48abb965182b7cff2a59caeaa8
+  data.tar.gz: 5b9127a06f6c68c9cb3050713c923263e4cae9fdb01477b05ad1cc2238c4fc0a046a2ecfea7f2a1ef97ce090bb16f02d6a75023240b0071baf8acc8a1ba183a2

data/.yardopts

@@ -0,0 +1,6 @@
+--no-cache
+--no-save
+--output-dir www
+lib/**/*.rb
+-
+LICENSE.txt

data/CHANGELOG

@@ -0,0 +1,8 @@
+= 0.2.0(2017-6-6)
+  * add load_all plugin
+  * add multi_dispatch plugin
+  * add csrf plugin
+  * add CHANGELOG
+
+= 0.1.0(2017-6-5)
+  * initial commit

data/README.md

@@ -1,6 +1,7 @@
 # RodaContrib
 
-The roda-contrib gem is my personal collection of plugins working with Roda(the Routing tree toolkit).
+The roda-contrib gem is my personal collection of plugins working with Roda(the
+Routing tree toolkit).
 
 ## Installation
 
@@ -20,17 +21,36 @@ Or install it yourself as:
 
 ## Usage
 
-<!-- TODO: Write usage instructions here -->
+Currently, the roda-contrib gem ships 3 plugins:
+
+* load\_all
+* multi\_dispatch
+* csrf
+
+When loading plugins from this gem, you should append the 'contrib' to the
+symbol to load it. For example, if you want to use the multi\_dispatch plugin:
+
+```ruby
+class App < Roda
+  plugin :contrib_multi_dispatch
+end
+```
+
+For details of the each plugin, please refer to the documentation or the code.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/luciusgone/roda-contrib.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/luciusgone/roda-contrib.
 
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,6 +1,11 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'yard'
 
 RSpec::Core::RakeTask.new(:spec)
 
+YARD::Rake::YardocTask.new do |t|
+  t.stats_options = ['--list-undoc']
+end
+
 task :default => :spec

data/doc/release_notes/0_1_0.rdoc

@@ -0,0 +1,3 @@
+= '0.1.0' release note
+
+Initial release

data/doc/release_notes/0_2_0.rdoc

@@ -0,0 +1,19 @@
+= 0.2.0 release note
+
+== New Features
+
+* add _contrib_load_all_ plugin.
+  This plugin helps writing clean code requiring different part of the roda
+  app.
+
+* add _contrib_multi_dispatch_ plugin.
+  This plugin helps seperating different logics by delegating request to an
+  external object.
+
+* add _contrib_csrf_ plugin.
+  Apart from the official csrf plugin, It exposes only one interface to make
+  the main roda app a bit clean.
+
+* add RodaContrib::Action
+  This mixin is the main way for roda-contrib to package plugable business
+  logic.

data/lib/roda/contrib/action.rb

@@ -0,0 +1,30 @@
+require 'forwardable'
+require 'roda/contrib/action/dispatchable'
+
+module RodaContrib
+  # The mixin is intended to use with the multi_dispatch plugin. It ships with
+  # Dispatchable module by default. Currently, it will load all modules defined
+  # under the RodaContrib::Action module
+  #
+  # If you want to use this mixin seperately, you must define the delegators
+  # properly:
+  #
+  #   SomeDispathcer.define_delegators(RodaApp)
+  #
+  # Examples:
+  #   see the multi_dispatch plugin
+  module Action
+    def self.included(base)
+      mod = self
+
+      base.class_eval do
+        extend ::Forwardable
+
+        mod.constants.each do |k|
+          c = mod.const_get(k)
+          include c if c.is_a? Module
+        end
+      end
+    end
+  end
+end

data/lib/roda/contrib/action/dispatchable.rb

@@ -0,0 +1,42 @@
+module RodaContrib
+  module Action
+    # Basic functionalities for +RodaContrib::Action+ mixin
+    #
+    # The call method is already taken by the roda app, so we have to introduce
+    # a new method finish to actually executing the route block.
+    module Dispatchable
+      def self.included(base)
+        base.class_eval do
+          include InstanceMethods
+          extend ClassMethods
+        end
+      end
+
+      module InstanceMethods
+        def initialize(scope)
+          @scope = scope
+        end
+
+        attr_reader :scope
+
+        def finish
+          blk = self.class.route_block
+          instance_exec(request, &blk)
+        end
+      end
+
+      module ClassMethods
+        attr_reader :route_block
+
+        def route(&block)
+          @route_block = block
+        end
+
+        def define_delegators(app)
+          m = app.instance_methods - Object.instance_methods
+          def_delegators :@scope, *m
+        end
+      end
+    end
+  end
+end

data/lib/roda/contrib/plugins/csrf.rb

@@ -0,0 +1,68 @@
+require 'rack/csrf'
+
+module RodaContrib
+  module Plugins
+    # The contrib_csrf plugin is a bit different from offical csrf plugin. It
+    # offers only one instance methods instead of five. It is just my personal
+    # flavor.
+    #
+    # You can use it like this:
+    #   # in the routing tree
+    #   csrf.field         # equivalent to offical csrf_field
+    #   csrf.header        # equivalent to offical csrf_header
+    #   csrf.metatag({})   # equivalent to offical csrf_metatag({})
+    #   csrf.tag           # equivalent to offical csrf_tag
+    #   csrf.token         # equivalent to offical csrf_token
+    #
+    # see alse Roda offical csrf plugin documentations
+    module Csrf
+      CSRF = ::Rack::Csrf
+
+      def self.configure(app, opts={})
+        return if opts[:skip_middleware]
+        app.instance_exec do
+          @middleware.each do |(mid, *rest), _|
+            if mid.equal?(CSRF)
+              rest[0].merge!(opts)
+              build_rack_app
+              return
+            end
+          end
+          use CSRF, opts
+        end
+      end
+
+      module InstanceMethods
+        class CsrfDecorator
+          def initialize(env)
+            @env = env
+          end
+
+          def field
+            CSRF.field
+          end
+
+          def header
+            CSRF.header
+          end
+
+          def metatag(opts={})
+            CSRF.metatag(@env, opts)
+          end
+
+          def tag
+            CSRF.tag(@env)
+          end
+
+          def token
+            CSRF.token(@env)
+          end
+        end
+
+        def csrf
+          @_csrf ||= CsrfDecorator.new(env)
+        end
+      end
+    end
+  end
+end

data/lib/roda/contrib/plugins/load_all.rb

@@ -0,0 +1,42 @@
+module RodaContrib
+  module Plugins
+    # the load_all plugin helps to write clean code loading related parts of
+    # the main roda app.
+    #
+    # It favors the +:root+ option of the roda app. If you set the +:root+
+    # option before you load this plugin, you can omit the +:root+ option of
+    # the plugin.
+    #
+    # Besides, you can load multiple directories at the same time, if loading
+    # order does not matter.
+    #
+    # === Example
+    #   class App < Roda
+    #     plugin :contrib_load_all, root: __dir__
+    #
+    #     # load multiple resources at the same time
+    #     load_all :models, :views
+    #     # load only one folder
+    #     load_all :helpers
+    #   end
+    #
+    # It will immediately load models and helpers files under the defined root
+    # dir.
+    module LoadAll
+      def self.configure(app, opts={})
+        raise ArgumentError, 'Invalid root option' unless app.opts[:root] || opts[:root]
+        app.opts[:root] = opts[:root] if opts[:root]
+      end
+
+      module ClassMethods
+        def load_all(*rcs)
+          rcs.each do |rc|
+            patterns = File.expand_path "./#{rc}/**/*.rb", opts[:root]
+            Dir[patterns].each { |f| require f }
+          end
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/roda/contrib/plugins/multi_dispatch.rb

@@ -0,0 +1,208 @@
+require 'roda/contrib/action'
+
+module RodaContrib
+  module Plugins
+    # The +multi_dispatch+ plugin let you process the your request in a
+    # different context rather than the main roda app. It borrows a lot of code
+    # from the official +multi_route+ plugin.
+    #
+    # === Rationals
+    # The original rational behind it is simple: avoiding huge interface which
+    # is hard to maintain. The reason why this approach is viable is that
+    # all routing methods lives within the +Roda::RodaRequest+ class. Thus,
+    # wherever you can access the request object, you can route and proceed
+    # your request.
+    #
+    # === Features
+    # The +RodaContrib+ ships a mixin to make the plugin work. You can also use
+    # this plugin in a more object oriented way.
+    #
+    # Just like +multi_route+ plugin support namespaced routes, +multi_dispatch+
+    # plugin support namespace but a bit differently. Also there can be an
+    # extra block pass to the +multi_dispatch+ method to handle requests not
+    # handled by dispatchers.
+    #
+    # === Things you should take care of
+    # The +multi_dispatch+ plugin should work fine with most of other plugins.
+    # The +render+ plugin is an exception, for it is evaluated in the roda app
+    # instance. You should either specify the scope option explicitly or use
+    # the +view_options+ plugin to set the scope in the routing tree before you
+    # render anything.
+    #
+    # There is one more thing you should pay attention to. You should always
+    # define dispatch after you load all the plugins and the helper mixins into
+    # your class.
+    #
+    # === Example
+    #   class App < Roda
+    #     plugin :contrib_multi_dispatch
+    #
+    #     # define dispatchers
+    #     dispatch 'hello' do
+    #       def say_hello
+    #         'hello'
+    #       end
+    #
+    #       route do |r|
+    #         r.get do
+    #           say_hello
+    #         end
+    #       end
+    #     end
+    #
+    #     dispatch 'hi' do
+    #       # we can define method with the same name in different dispatchers
+    #       def say_hello
+    #         'said hi instead of hello'
+    #       end
+    #
+    #       route do |r|
+    #         r.get do
+    #           say_hello
+    #         end
+    #       end
+    #     end
+    #
+    #     # namespaced dispatcher
+    #     dispatch 'yarn', namespace: 'somebody' do
+    #       def yarn
+    #         'somebody yarned'
+    #       end
+    #
+    #       route do |r|
+    #         r.get do
+    #           yarn
+    #         end
+    #       end
+    #     end
+    #
+    #     # class based dispatcher
+    #     class SayGoodbye
+    #       include ::RodaContrib::Action
+    #
+    #       def say_good_bye
+    #         'goodbye'
+    #       end
+    #
+    #       route do |r|
+    #         r.get do
+    #           say_good_bye
+    #         end
+    #       end
+    #     end
+    #
+    #     dispatch 'goodbye', to: SayGoodbye
+    #
+    #     route do |r|
+    #       # dispatch request without namespace
+    #       r.multi_dispatch
+    #
+    #       r.on 'somebody' do
+    #         # dispatch namespaced dispatchers
+    #         r.multi_dispatch('somebody')
+    #       end
+    #     end
+    #   end
+    #
+    # the example above shows you how to add dispatchers, how to use namespaced
+    # dispatchers, how to use class based dispatchers, how to dispatch request
+    # to dispatchers.
+    module MultiDispatch
+      def self.configure(app)
+        app.opts[:namespaced_dispatchers] ||= {}
+        app::RodaRequest.instance_variable_set(:@namespaced_dispatchers_regexps, {})
+        app.opts[:namespaced_dispatchers].each do |ns, dispatchers|
+          app::RodaRequest.build_named_dispatcher_regexp!(ns)
+        end
+      end
+
+      module ClassMethods
+        def freeze
+          opts[:namespaced_dispatchers].freeze
+          opts[:namespaced_dispatchers].each_value(&:freeze)
+          super
+        end
+
+        def inherited(subclass)
+          super
+          sub_ndps = subclass.opts[:namespaced_dispatchers] = {}
+          opts[:namespaced_dispatchers].each do |k1, v1|
+            sub_ndps[k1] = {}
+            v1.each do |k2, v2|
+              sub_ndps[k1][k2] = v2.dup
+            end
+          end
+          subclass::RodaRequest.instance_variable_set(:@namespaced_dispatchers_regexps, {})
+          sub_ndps.each { |k, v| subclass::RodaRequest.build_named_dispatcher_regexp!(k) }
+        end
+
+        def named_dispathers(namespace=nil)
+          targets = opts[:namespaced_dispatchers][namespace]
+          targets ? targets.keys : []
+        end
+
+        def named_dispatcher(name, namespace=nil)
+          opts[:namespaced_dispatchers][namespace][name]
+        end
+
+        def dispatch(name, namespace: nil, to: nil, &block)
+          opts[:namespaced_dispatchers][namespace] ||= {}
+
+          if dispatcher = opts[:namespaced_dispatchers][namespace][name]
+            dispatcher.class_eval(&block)
+          elsif to.nil?
+            roda_app = self
+            dispatcher = Class.new do
+              include ::RodaContrib::Action
+              define_delegators(roda_app)
+              class_eval(&block)
+            end
+          else
+            to.define_delegators(self)
+          end
+
+          opts[:namespaced_dispatchers][namespace][name] = dispatcher || to
+          self::RodaRequest.clear_named_dispatcher_regexp!(namespace)
+          self::RodaRequest.build_named_dispatcher_regexp!(namespace)
+        end
+      end
+
+      module RequestClassMethods
+        def clear_named_dispatcher_regexp!(namespace=nil)
+          @namespaced_dispatchers_regexps.delete(namespace)
+        end
+
+        def build_named_dispatcher_regexp!(namespace=nil)
+          @namespaced_dispatchers_regexps[namespace] = /(#{Regexp.union(dispatcher_ary(namespace))})/
+        end
+
+        def named_dispatcher_regexp(namespace=nil)
+          @namespaced_dispatchers_regexps[namespace]
+        end
+
+        private
+        def dispatcher_ary(namespace)
+          roda_class.named_dispathers(namespace).select{ |s| s.is_a?(String) }.sort.reverse
+        end
+      end
+
+      module RequestMethods
+        def multi_dispatch(namespace=nil)
+          on self.class.named_dispatcher_regexp(namespace) do |section|
+            r = dispatch(section, namespace: namespace)
+            if block_given?
+              yield
+            else
+              r
+            end
+          end
+        end
+
+        def dispatch(name, namespace: nil)
+          dispatcher = roda_class.named_dispatcher(name, namespace)
+          dispatcher.new(scope).finish
+        end
+      end
+    end
+  end
+end

data/lib/roda/contrib/version.rb

@@ -1,3 +1,3 @@
 module RodaContrib
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/roda/plugins/contrib_csrf.rb

@@ -0,0 +1,3 @@
+require 'roda/contrib/plugins/csrf'
+
+Roda::RodaPlugins.register_plugin(:contrib_csrf, RodaContrib::Plugins::Csrf)

data/lib/roda/plugins/contrib_load_all.rb

@@ -0,0 +1,3 @@
+require 'roda/contrib/plugins/load_all'
+
+Roda::RodaPlugins.register_plugin(:contrib_load_all, RodaContrib::Plugins::LoadAll)

data/lib/roda/plugins/contrib_multi_dispatch.rb

@@ -0,0 +1,3 @@
+require 'roda/contrib/plugins/multi_dispatch'
+
+Roda::RodaPlugins.register_plugin(:contrib_multi_dispatch, RodaContrib::Plugins::MultiDispatch)

data/roda-contrib.gemspec

@@ -14,8 +14,10 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/luciusgone/roda-contrib'
   spec.license       = 'MIT'
 
+  spec.required_ruby_version = ">= 2.3.1"
+
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features|bin)/})
+    f.match(%r{^(test|spec|features|bin|www)/})
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -24,4 +26,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rack_csrf'
+
+  spec.add_dependency 'roda', '~> 2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda-contrib
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - luciusgone
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-05 00:00:00.000000000 Z
+date: 2017-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: rack-test
+  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: rack_csrf
+  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: roda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: Small collection of my personal plugins for Roda
 email:
 - luciusgone@gmail.com
@@ -62,12 +118,24 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".yardopts"
+- CHANGELOG
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- doc/release_notes/0_1_0.rdoc
+- doc/release_notes/0_2_0.rdoc
 - lib/roda/contrib.rb
+- lib/roda/contrib/action.rb
+- lib/roda/contrib/action/dispatchable.rb
+- lib/roda/contrib/plugins/csrf.rb
+- lib/roda/contrib/plugins/load_all.rb
+- lib/roda/contrib/plugins/multi_dispatch.rb
 - lib/roda/contrib/version.rb
+- lib/roda/plugins/contrib_csrf.rb
+- lib/roda/plugins/contrib_load_all.rb
+- lib/roda/plugins/contrib_multi_dispatch.rb
 - roda-contrib.gemspec
 homepage: https://github.com/luciusgone/roda-contrib
 licenses:
@@ -81,7 +149,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="