forerunner 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 584c35a67b59024c9d703c5c07ca4ddc5dbef118
+  data.tar.gz: 5de3fa5fffaf7e77ab99ca025511853dd17784d9
+SHA512:
+  metadata.gz: 3e6bc59175af7aca43dd00725e96a2688be87a6102b4e828ec4468fd8f56198f3ec3c6991be4cfe3dc44f4cf2a89a5f31d5e775900353951eff873c13905ff6a
+  data.tar.gz: f6e74a85fd009a7a05cc4868b8c396bf2617afc461b6ff933c9b65ccad86e50b072c48c4cbcb7d1b7d3011bae9dceadfd885bc7119312215e5925ccc2dd74ee5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Greg White
+
+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,123 @@
+# Forerunner
+Forerunner defines a simple, familiar DSL for definining callbacks above
+controller actions instead of defining them at the top of the class using
+`before_action`. Instead of constantly going back to the top of your controllers
+to see which methods should be called before a controller action, just look
+above the controller action's definition!
+
+Using `before_action` works well for most cases, but it falls short when you
+have methods that should only be run for one method, or when your controllers
+grow large. It becomes  a pain to know exactly what happens before each
+controller action, and that's exactly the problem that `Forerunner` intends to
+solve.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'forerunner'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself by running:
+```bash
+$ gem install forerunner
+```
+
+## Getting Started
+
+Using `Forerunner` is quite easy. In your `ApplicationController`, just `include
+Forerunner`. That's it!
+
+Here's a barebones implementation:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include Forerunner
+end
+```
+
+Now you have the `Forerunner` library available to you in all controllers that
+subclass `ApplicationController`.  You can also include this on a controller by
+controller basis, if you don't anticipate needing it everywhere.
+
+## Usage
+
+`Forerunner` provides you with a new method called `precede_with` that defines
+allows you to specify a method to get called before the next defined controller
+action.
+
+Essentially, these two things are equivalent:
+```ruby
+# Normal implementation
+class ExampleController < ApplicationController
+  before_action :do_a_thing, only: %i(index)
+  
+  def index
+    # index logic goes here
+  end
+end
+
+# Forerunner implementation
+class ExampleController < ApplicationController
+  precede_with :do_a_thing
+  def index
+    # index logic goes here
+  end
+end
+```
+
+Let's say you have a `PostsController` that allows anyone to view posts, but
+only allows authorized users to create new posts. Here's how your controller
+would likely look:
+
+```ruby
+class PostsController < ApplicationController
+  before_action :authorize_user, only: %i(create)
+  before_action :another_action, only: %i(create)
+  
+  def index
+    # index logic goes here
+  end
+  
+  def create
+    # create logic goes here
+  end
+end
+```
+
+The problem with this is that at a glance, you don't know what happens before
+`create` is called.  The methods are in two separate lines at the top of the
+class, far away from the actual `create` definition.  Instead, what if you could
+know what happens before each action at a glance?
+
+Here's how that controller would look if it utilized `Forerunner`:
+
+```ruby
+class PostsController < ApplicationController
+  def index
+    # index logic goes here
+  end
+
+  precede_with :authorize_user, :another_action
+  def create
+    # create logic goes here
+  end
+end
+```
+
+In this implementation, you don't have to worry about what happens before
+`create` is called; it's readily apparent! You can immediately tell that
+`authorize_user` is called, immediately followed by `another_action`.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Coming Soon
+* `after_action`
+* `around_action`
+* Support for `prepend_#{type}_action`

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Forerunner'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/forerunner.rb

@@ -0,0 +1,24 @@
+require "active_support"
+require "forerunner/analyzer"
+require "forerunner/action_data"
+require "forerunner/action_data/missing_action_name_error"
+require "forerunner/action_data/invalid_action_type_error"
+require "forerunner/builder"
+
+module Forerunner
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def precede_with(*filter_params, &block)
+      forerunner_builder.enqueue_action(:before, filter_params, block)
+    end
+
+    def method_added(controller_action)
+      forerunner_builder.process_actions(controller_action)
+    end
+
+    def forerunner_builder
+      @forerunner_builder ||= Forerunner::Builder.new(self)
+    end
+  end
+end

data/lib/forerunner/action_data.rb

@@ -0,0 +1,39 @@
+module Forerunner
+  class ActionData
+    VALID_ACTION_TYPES = %i(before around after)
+
+    attr_reader :options, :action_names, :block, :action_type
+
+    def initialize(action_type:, action_data:, block: nil)
+      @action_type = action_type
+      @options = action_data.extract_options!
+      @action_names = action_data
+      @block = block
+
+      validate_action_type!
+      validate_action_names!
+    end
+
+    def limit_to_action(action)
+      options[:only] = [action]
+    end
+
+    def params
+      action_names + [options]
+    end
+
+    private
+
+    def validate_action_type!
+      return if VALID_ACTION_TYPES.include?(action_type)
+
+      raise InvalidActionTypeError, action_type
+    end
+
+    def validate_action_names!
+      return if action_names.present? || block.present?
+
+      raise MissingActionNameError
+    end
+  end
+end

data/lib/forerunner/action_data/invalid_action_type_error.rb

@@ -0,0 +1,23 @@
+module Forerunner
+  class ActionData
+    class InvalidActionTypeError < StandardError
+      attr_reader :action_type
+
+      def initialize(action_type)
+        @action_type = action_type
+      end
+
+      def to_s
+        "Invalid action type `#{action_type}`. Valid types include #{valid_types}."
+      end
+
+      private
+
+      def valid_types
+        Forerunner::ActionData::VALID_ACTION_TYPES.map do |valid_type|
+          "`#{valid_type}`"
+        end.to_sentence
+      end
+    end
+  end
+end

data/lib/forerunner/action_data/missing_action_name_error.rb

@@ -0,0 +1,9 @@
+module Forerunner
+  class ActionData
+    class MissingActionNameError < StandardError
+      def to_s
+        "Forerunner filter must have at least one action name"
+      end
+    end
+  end
+end

data/lib/forerunner/analyzer.rb

@@ -0,0 +1,9 @@
+module Forerunner
+  class Analyzer
+    attr_reader :controller
+
+    def initialize(controller)
+      @controller = controller
+    end
+  end
+end

data/lib/forerunner/builder.rb

@@ -0,0 +1,43 @@
+module Forerunner
+  class Builder
+    attr_reader :controller
+    attr_accessor :actions
+
+    delegate :_insert_callbacks, :set_callback, to: :controller
+
+    def initialize(controller)
+      @controller = controller
+      @actions = []
+    end
+
+    def enqueue_action(action_type, action_params, block)
+      actions << parse_action_data(action_type, action_params, block)
+    end
+
+    def process_actions(target_action)
+      actions.each do |action_data|
+        insert_new_filter(target_action, action_data)
+      end
+
+      actions.clear
+    end
+
+    private
+
+    def insert_new_filter(target_action, action_data)
+      action_data.limit_to_action(target_action)
+
+      _insert_callbacks(action_data.params, action_data.block) do |name, options|
+        set_callback(:process_action, action_data.action_type, name, options)
+      end
+    end
+
+    def parse_action_data(action_type, action_params, block)
+      ActionData.new(
+        action_type: action_type,
+        action_data: action_params,
+        block: block
+      )
+    end
+  end
+end

data/lib/forerunner/version.rb

@@ -0,0 +1,3 @@
+module Forerunner
+  VERSION = '0.1.1'
+end

data/lib/tasks/forerunner_tasks.rake

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

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: forerunner
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Greg White
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: pry
+  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: rubocop
+  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: Run before_actions in a more intuitive way.
+email:
+- gkwhite95@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/forerunner.rb
+- lib/forerunner/action_data.rb
+- lib/forerunner/action_data/invalid_action_type_error.rb
+- lib/forerunner/action_data/missing_action_name_error.rb
+- lib/forerunner/analyzer.rb
+- lib/forerunner/builder.rb
+- lib/forerunner/version.rb
+- lib/tasks/forerunner_tasks.rake
+homepage: 
+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.6.3
+signing_key: 
+specification_version: 4
+summary: Forerunner 0.1.1
+test_files: []