roda-controller 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58cf1d688a6323bd7062c3561f6fd52a47d7fe96
+  data.tar.gz: cfcc8845a0a6955cded710ddb2fd6aa2625a6bcb
+SHA512:
+  metadata.gz: 8aecd480e38e2287c1344dc84d36b11c6247ac80d02956838767e2a1f50728a7d9cbb43c70623910b695db69b426c2e12cb5dc71ba9c0ffea741333c216895db
+  data.tar.gz: a74e9ab398dadd0b6d6c0f1a95b85947d2ae66e4a7627258fff72075481ce22c79f9644f3c2bb42bc6516495fdb397c7e46829d2cb1d82e0463809e7ef801d7f

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Amadeus Folego
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,226 @@
+# Roda Controller
+
+Adds controller functionality to Roda
+
+## Configuration
+
+Configure your Roda application to use this plugin:
+
+```ruby
+plugin :controller
+```
+
+You can already register your controllers:
+
+```ruby
+plugin :controller, controllers: { users: UsersController }
+
+# Infer controller key to 'users'
+plugin :controller, controllers: [UsersController]
+
+# Infer controller key to 'users_handler'
+plugin :controller, controllers: [UsersHandler]
+```
+
+```ruby
+
+You may also register controllers later, inside your application class
+declaration:
+
+```ruby
+register_controller UsersController
+register_controller MoviesController
+
+# Passing a list of controllers
+register_controller [UsersController, MoviesController]
+
+# Explicitly declaring the controller key
+register_controller :users, UsersHandler
+register_controller :movies, MoviesHandler
+```
+
+## Usage
+
+### Controller Naming
+
+The controller class is not required to follow any naming convention,
+specially if you specify explicitly the controller key when registered.
+
+However if it ends with `Controller` this will be stripped from the
+controller key if it is inferred. I.E. `UsersController => 'users'` and
+`UsersHandler => 'users_handler'`
+
+### Controller Definition
+
+You just need to implement the methods with the action names you are going to
+use:
+
+```ruby
+class UsersController
+  def index
+    "User Index"
+  end
+
+  def show(user_id)
+    "User Show ##{user_id}"
+  end
+end
+```
+
+### Dispatching to controllers
+
+Call `#dispatch` whenever you want to receive the result of the
+controller action, this is a textbook RESTful routing definition:
+
+```ruby
+r.on("users") do
+  r.is do
+    r.get do
+      dispatch('users#index')
+    end
+
+    r.post do
+      dispatch('users#create', args: r.params)
+    end
+  end
+
+  r.on(:id) do |user_id|
+    r.is do
+      r.get do
+        dispatch('users#show', args: user_id)
+      end
+
+      r.patch do # requires all_verbs plugin to be loaded
+        dispatch('users#update', args: [user_id, r.params])
+      end
+
+      r.delete do # requires all_verbs plugin to be loaded
+        dispatch('users#destroy', args: user_id)
+      end
+    end
+  end
+end
+```
+
+### Receiving dispatched responses
+
+You may expose the controller responses using the `@responds_with` variable:
+
+```ruby
+# users_controller.rb
+class UsersController
+  def show(user_id)
+    user = user: User.find(user_id)
+
+    @responds_with = { user: user, best_movie: Movie.best_for(user) }
+  end
+end
+
+# app.rb
+r.get do
+  dispatch('users#show', args: user_id)
+
+  # Do stuff with @user and @best_movie, or access @responds_with directly
+  # if the instance variable cannot be overwritten
+end
+```
+
+### Rendering Views
+
+If you are using the render plugin you can use the `#controller` method instead
+of `#dispatch`. It receives the same parameters but will call the `#view`
+method with the following convention:
+
+```ruby
+controller('users#show', args: user_id) # will call view('users/show')
+```
+
+### Initializing Controllers
+
+You may specify parameters for controller initialization, to provide
+context to your actions without polluting the method arguments: 
+
+```ruby
+# users_controller.rb
+class UsersController
+  attr_reader :request, :response
+
+  def initialize(request, response)
+    @request = request
+    @response = response
+  end
+
+  # be able to access the request and response inside actions
+
+# app.rb
+## inside routes
+dispatch('users#update', args: [user_id, r.params], inject: [request, response])
+## registering controller
+register_controller(:users, -> { |req, res| UsersController.new(req, res) }
+```
+
+### Advanced Configuration
+
+You can setup default arguments for the `#dispatch` and `#controller` methods:
+
+```ruby
+# Will always initialize controllers with request and response args
+plugin :controller, inject: ->{ [request, response] }
+```
+
+### DRYing up
+
+By following conventions you may dry everything up.
+
+This:
+
+- Creates a `RodaController` class to be inherited on your controllers
+- Exposes request and response variables inside actions
+- Adds helper methods to your actions
+- Automatically loads all controllers inside `controllers` folder
+
+```ruby
+# roda_controller.rb
+class RodaController
+  attr_reader :request, :response
+
+  # Access request and response methods
+  def initialize(request, response)
+    @request = request
+    @response = response
+  end
+
+  # Enables respond_with exposed_variable: local_variable
+  def respond_with(opts)
+    @responds_with ||= {}
+    @responds_with.merge!(opts)
+  end
+
+  # Get list of all controllers
+  def self.descendants
+    ObjectSpace.each_object(Class).select { |klass| klass < self }
+  end
+end
+
+# app.rb
+## configuring the plugin
+plugin :controller, inject: ->{ [request, response] }
+
+## automatically registering all controllers inside controllers folder 
+Dir["controllers/*.rb"].each { |file| require_relative file }
+
+RodaController.descendants.each do |controller|
+  controller_key = Roda::RodaPlugins::Controller.underscore(controller.name)
+  controller_proc = -> (req, res) { controller.new(req, res) }
+
+  register_controller(controller_key, controller_proc)
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/badosu/roda-controller
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task default: :spec

data/lib/roda/plugins/controller.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require "roda/plugins/controller/version"
+
+class Roda
+  module RodaPlugins
+    module Controller
+      DEFAULTS = {
+        registered_controllers: {},
+        inject: nil,
+        args: nil
+      }
+
+      def self.configure(app, opts={}, &block)
+        plugin_opts = (app.opts[:controller] ||= DEFAULTS)
+
+        app.opts[:controller] = plugin_opts.merge(opts)
+
+        app.register_controller(opts[:controllers]) if opts[:controllers]
+      end
+
+      def self.underscore(name, acronym_regex: /(?=a)b/)
+        return name unless name =~ /[A-Z-]|::/
+
+        name.gsub!(/Controller$/, "")
+
+        word = name.to_s.gsub("::", "/")
+        word.gsub!(/(?:(?<=([A-Za-z\d]))|\b)(#{acronym_regex})(?=\b|[^a-z])/) { "#{$1 && '_' }#{$2.downcase}" }
+        word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+        word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+        word.tr!("-", "_")
+        word.downcase!
+        word
+      end
+
+      module ClassMethods
+        def register_controller(*args)
+          controllers = opts[:controller][:registered_controllers]
+
+          if args.size == 2
+            controller_key, controller = args
+
+            controllers.merge! controller_key.to_sym => controller
+          elsif args.size == 1
+            controller = args[0]
+
+            if controller.kind_of? Hash
+              controllers.merge!(controller)
+            elsif controller.kind_of? Array
+              controller.each {|c| register_controller(c) }
+            elsif controller.kind_of? Class
+              register_controller(Controller.underscore(controller.name), controller)
+            end
+          end
+        end
+      end
+
+      module InstanceMethods
+        def dispatch(to, args: nil, inject: nil)
+          controller_key, action = to.to_s.split('#')
+          controllers = opts[:controller][:registered_controllers]
+          controller = controllers[controller_key.to_sym]
+
+          inject ||= opts[:controller][:inject]
+
+          if inject.respond_to?(:to_proc)
+            controller_args = Array(instance_exec(&inject))
+          else
+            controller_args = Array(inject)
+          end
+
+          if controller.respond_to?(:to_proc)
+            controller = controller.to_proc.call(*controller_args)
+          elsif controller.kind_of?(Class)
+            controller = controller.new(*controller_args)
+          end
+
+          response = controller.send(action, *Array(args))
+
+          responds_with = controller.instance_variable_get(:@responds_with)
+          responds_with ||= {}
+
+          responds_with.each do |var, val|
+            ivar = :"@#{var}"
+
+            if !instance_variable_defined?(ivar)
+              instance_variable_set(ivar, val)
+            end
+          end
+
+          response
+        end
+
+        def controller(to, args: nil, inject: nil)
+          controller_key, action = to.to_s.split('#')
+
+          result = dispatch(to, args: args, inject: inject)
+
+          view("#{controller_key}/#{action}")
+
+          result
+        end
+      end
+    end
+
+    register_plugin(:controller, Controller)
+  end
+end

data/lib/roda/plugins/controller/version.rb

@@ -0,0 +1,7 @@
+require 'roda'
+
+module Roda::RodaPlugins
+  module Controller
+    VERSION = "0.1.0"
+  end
+end

data/roda-controller.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'roda/plugins/controller/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "roda-controller"
+  spec.version       = Roda::RodaPlugins::Controller::VERSION
+  spec.authors       = ["Amadeus Folego"]
+  spec.email         = ["amadeusfolego@gmail.com"]
+
+  spec.summary       = %q{Adds controller functionality to Roda}
+  spec.description   = %q{Adds controller functionality to Roda}
+  spec.homepage      = "https://github.com/badosu/roda-controller"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "roda", "~> 2.0"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: roda-controller
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Amadeus Folego
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-16 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Adds controller functionality to Roda
+email:
+- amadeusfolego@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/roda/plugins/controller.rb
+- lib/roda/plugins/controller/version.rb
+- roda-controller.gemspec
+homepage: https://github.com/badosu/roda-controller
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Adds controller functionality to Roda
+test_files: []