toy-verbs 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,84 @@
+Toy Verbs
+=========
+
+Toy Verbs is a component of [Toy Locomotive](https://github.com/Mortaro/Toy-Locomotive]), but can be used independently outside Toy Locomotive.
+
+
+Getting Started
+---------------
+
+All you need to start using Toy Attributes is to add the following line to your application's Gemfile:
+
+    gem "toy-verbs"
+
+Routing with Verbs
+------------------
+
+This gem allows you to declare a route and an action inside your controller. In order to make it happen, your controller will have access to the following class methods:
+
+    get, post, put, delete, match
+
+Each verb is followed by a route, which will be mapped to a generated action. A block is accepted to define the action behavior, but it can also use a clean default:
+
+    class SiteController < ApplicationController
+
+      get '/' do
+        render text: 'welcome'
+      end
+
+      get '/contact'
+
+    end
+
+In this example, accessing `http://localhost:3000/` in your browser will render the text "welcome", and accessing `http://localhost:300/contact` will invoke the view `site/contact`
+
+The verb `get` also accepts multiple routes if they have empty actions, as many symbols and/or strings can be passed to this verb and each will generate a route.
+
+    class SiteController < ApplicationController
+
+      get '/', '/terms-of-service'
+
+      get :root, :terms_of_service
+
+      get '/', :terms_of_service
+
+    end
+
+*Note that `:root` is the symbolic representation of the special path `'/'`*
+
+Verbs Options
+-------------
+
+Besides the path, each verb also accepts a hash with options.
+
+Every route declared using a verb will generate a path helper, just like the named routes defined in `config/routes.rb`. You can see the pattern that generates the helpers below:
+
+    get '/' # => root_path
+    get '/terms-of-service' # => terms_of_service_path
+    get :posts, :tags # => posts_path, tags_path
+    get '/posts/:post_id/:comments/:comment_id' # => post_comment_path
+
+This behavior can be overwritten by passing the ':as' option to the verb:
+
+  get '/terms-of-service', as: 'tos' # => tos_path
+
+As said before, an action will be generated, but this behavior can also be overwritten by passing the option ':action' to the verb. It is usefull for inherited actions or actions that you do not have explicit access to.
+
+    class ApplicationController < ActionController:Base
+      def save_contact
+        # save the contact from a form and send copy via e-mail
+      end
+    end
+
+    class SiteController < ApplicationController
+      post '/contact', action: 'save_contact'
+    end
+
+Drawing Routes
+--------------
+
+Even if you still can write routes normaly on your `config/routes.rb`, it's possible to evaluate directly from inside your controller using `draw`, which may turn up being useful if you are using gems like devise, or even writing a plugin for rails:
+
+    class UsersController < ApplicationController
+      draw :devise_for, :users
+    end

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ToyVerbs'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/tasks/toy-verbs_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :toy-verbs do
+#   # Task goes here
+# end

data/lib/toy-verbs.rb

@@ -0,0 +1,8 @@
+module ToyVerbs
+  VERBS = [:get, :post, :put, :delete, :match]
+end
+
+require 'action_controller'
+
+require 'toy-verbs/matcher'
+require 'toy-verbs/railtie' if defined?(Rails)

data/lib/toy-verbs/matcher.rb

@@ -0,0 +1,59 @@
+module ToyVerbs::Matcher
+
+  ToyVerbs::VERBS.each do |verb|
+    define_method verb do |path, opts={}, &blk|
+      route_action verb, path, opts, &blk
+    end
+  end
+
+  alias :_get :get
+
+  def get *args, &blk
+    return _get *args, &blk unless args[1].is_a?(Symbol) || args[1].is_a?(String)
+    args.each { |action| _get action }
+  end
+
+  def draw *args
+    router = Rails.application.routes
+    router.disable_clear_and_finalize = true
+    router.draw { send(*args) }
+  end
+
+  private
+
+  def route_action verb, path, opts, &blk
+    path = extract_path path
+    draw verb, path => "#{extract_controller}##{extract_action(path, opts)}", as: extract_name(path, opts)
+    return if opts[:action]
+    blk = blk || Proc.new {}
+    define_method extract_action(path, opts).to_sym, &blk
+  end
+
+  def extract_controller
+    to_s.gsub('Controller', '').underscore
+  end
+
+  def extract_path path
+    path.is_a?(Symbol) ? "/#{path.to_s.gsub('_','-')}" : path
+  end
+
+  def extract_action path, opts
+    opts[:action] || path_to_method(path)
+  end
+
+  def extract_name path, opts
+    opts[:as] || path_to_method(path)
+  end
+
+  def path_to_method path
+    return 'root' if path == '/'
+    fragments = path.split('/')
+    fragments.each_with_index.map do |fragment, index|
+      next if fragment[0] == ':'
+      ((fragments[index+1] && fragments[index+1][0] == ':') ? fragment.singularize : fragment).parameterize.underscore
+    end.delete_if{ |fragment| fragment.blank? }.join('_')
+  end
+
+end
+
+ActionController::Base.extend ToyVerbs::Matcher

data/lib/toy-verbs/railtie.rb

@@ -0,0 +1,13 @@
+module ToyVerbs
+
+  def self.load! dir_path
+    Dir[dir_path].each { |file| load file }
+  end
+
+  class Engine < Rails::Engine
+    loader = Proc.new { ToyVerbs.load! "#{Rails.root}/app/controllers/*.rb" }
+    config.to_prepare &loader
+    initializer 'toy_attributes.load_routes', :after => :disable_dependency_loading, &loader
+  end
+
+end

data/lib/toy-verbs/version.rb

@@ -0,0 +1,3 @@
+module ToyVerbs
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: toy-verbs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Christian Mortaro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &30142308 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *30142308
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &30142056 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *30142056
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &30141804 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *30141804
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &30141540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *30141540
+description: Allows to use routing verbs directly inside a Rails controller
+email:
+- christian.mortaro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/tasks/toy-verbs_tasks.rake
+- lib/toy-verbs/matcher.rb
+- lib/toy-verbs/railtie.rb
+- lib/toy-verbs/version.rb
+- lib/toy-verbs.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/Mortaro/Toy-Verbs
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -471493315
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -471493315
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Handles the routing verbs for Toy-Locomotive
+test_files: []