simple_controller 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 20f1e8a4f6f58fa76e1ee3679e43aae283a7fd4e
+  data.tar.gz: 43d4c9d22826ae45ad8b8dac49e7a3b8b4de47c6
+SHA512:
+  metadata.gz: a11908aca45ebbfa600a58167c38b1cbbc6d84983bee759f3c0120fcbac25c716e2ce8450d2553edb69321389be53b871802d842148c4e077ec87a7dffd516a6
+  data.tar.gz: 0af55254de294c9d72731feedb60f05f455982e14839f7943b5a794fe7dd4b607b5c5c39c741dc08a7efd4d10c49fefc6493fcce1ed1d6a55d3d4f5c39c944de

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+script: bundle exec rspec
+rvm:
+  - 2.1.0
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_controller.gemspec
+gemspec
+
+gem "bundler", "> 1.3"
+gem "rake", "~> 10.0"
+
+group :test do
+  gem "rspec"
+  gem "codeclimate-test-reporter"
+  gem 'pry-byebug'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Steve Chung
+
+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,42 @@
+# SimpleController
+
+Use the Ruby on Rails Controller pattern outside of the Rails request stack.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_controller'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_controller
+
+## Usage
+
+```ruby
+class UserController < SimpleController::Base
+    before_action do
+        @user = User.find(params[:user_id])
+    end
+
+    def touch
+        @user.touch
+        @user
+    end
+end
+
+UserController.call(:touch, user_id: 1) # => returns User object
+UserController.new.call(:touch, user_id: 1) # => same as above
+```
+
+It works like a Rails Controller, but has only has the following features:
+- Callbacks
+- `params`
+- `action_name`

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simple_controller"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/simple_controller.rb

@@ -0,0 +1,18 @@
+autoload = false
+# autoload = true #uncomment for testing purposes only, not covered by rspec
+
+require "simple_controller/version"
+
+require 'active_support/callbacks'
+require 'active_support/hash_with_indifferent_access'
+
+if autoload && defined?(Rails)
+  require 'simple_controller/engine'
+else
+  require 'simple_controller/base'
+end
+
+
+module SimpleController
+  # Your code goes here...
+end

data/lib/simple_controller/base.rb

@@ -0,0 +1,9 @@
+require 'simple_controller/core'
+require 'simple_controller/callbacks'
+
+module SimpleController
+  class Base
+    include Core
+    include Callbacks # included last to wrap method
+  end
+end

data/lib/simple_controller/callbacks.rb

@@ -0,0 +1,188 @@
+# based on: https://github.com/rails/rails/blob/d2876141d08341ec67cf6a11a073d1acfb920de7/actionpack/lib/abstract_controller/callbacks.rb
+module SimpleController
+  module Callbacks
+    extend ActiveSupport::Concern
+
+    # Uses ActiveSupport::Callbacks as the base functionality. For
+    # more details on the whole callback system, read the documentation
+    # for ActiveSupport::Callbacks.
+    include ActiveSupport::Callbacks
+
+    included do
+      define_callbacks :call_action
+    end
+
+    # Override SimpleController::Base's call to run the
+    # call callbacks around the normal behavior.
+    def call_action(*args)
+      run_callbacks(:call_action) do
+        super
+      end
+    end
+
+    module ClassMethods
+      # If +:only+ or +:except+ are used, convert the options into the
+      # +:if+ and +:unless+ options of ActiveSupport::Callbacks.
+      #
+      # The basic idea is that <tt>:only => :index</tt> gets converted to
+      # <tt>:if => proc {|c| c.action_name == "index" }</tt>.
+      #
+      # Note that <tt>:only</tt> has priority over <tt>:if</tt> in case they
+      # are used together.
+      #
+      #   only: :index, if: -> { true } # the :if option will be ignored.
+      #
+      # Note that <tt>:if</tt> has priority over <tt>:except</tt> in case they
+      # are used together.
+      #
+      #   except: :index, if: -> { true } # the :except option will be ignored.
+      #
+      # ==== Options
+      # * <tt>only</tt>   - The callback should be run only for this action
+      # * <tt>except</tt>  - The callback should be run for all actions except this action
+      def _normalize_callback_options(options)
+        _normalize_callback_option(options, :only, :if)
+        _normalize_callback_option(options, :except, :unless)
+      end
+
+      def _normalize_callback_option(options, from, to) # :nodoc:
+        if from = options[from]
+          from = Array(from).map {|o| "action_name == '#{o}'"}.join(" || ")
+          options[to] = Array(options[to]).unshift(from)
+        end
+      end
+
+      # Take callback names and an optional callback proc, normalize them,
+      # then call the block with each callback. This allows us to abstract
+      # the normalization across several methods that use it.
+      #
+      # ==== Parameters
+      # * <tt>callbacks</tt> - An array of callbacks, with an optional
+      #   options hash as the last parameter.
+      # * <tt>block</tt>    - A proc that should be added to the callbacks.
+      #
+      # ==== Block Parameters
+      # * <tt>name</tt>     - The callback to be added
+      # * <tt>options</tt>  - A hash of options to be used when adding the callback
+      def _insert_callbacks(callbacks, block = nil)
+        options = callbacks.extract_options!
+        _normalize_callback_options(options)
+        callbacks.push(block) if block
+        callbacks.each do |callback|
+          yield callback, options
+        end
+      end
+
+      ##
+      # :method: before_action
+      #
+      # :call-seq: before_action(names, block)
+      #
+      # Append a callback before actions. See _insert_callbacks for parameter details.
+
+      ##
+      # :method: prepend_before_action
+      #
+      # :call-seq: prepend_before_action(names, block)
+      #
+      # Prepend a callback before actions. See _insert_callbacks for parameter details.
+
+      ##
+      # :method: skip_before_action
+      #
+      # :call-seq: skip_before_action(names)
+      #
+      # Skip a callback before actions. See _insert_callbacks for parameter details.
+
+      ##
+      # :method: append_before_action
+      #
+      # :call-seq: append_before_action(names, block)
+      #
+      # Append a callback before actions. See _insert_callbacks for parameter details.
+
+      ##
+      # :method: after_action
+      #
+      # :call-seq: after_action(names, block)
+      #
+      # Append a callback after actions. See _insert_callbacks for parameter details.
+
+      ##
+      # :method: prepend_after_action
+      #
+      # :call-seq: prepend_after_action(names, block)
+      #
+      # Prepend a callback after actions. See _insert_callbacks for parameter details.
+
+      ##
+      # :method: skip_after_action
+      #
+      # :call-seq: skip_after_action(names)
+      #
+      # Skip a callback after actions. See _insert_callbacks for parameter details.
+
+      ##
+      # :method: append_after_action
+      #
+      # :call-seq: append_after_action(names, block)
+      #
+      # Append a callback after actions. See _insert_callbacks for parameter details.
+
+      ##
+      # :method: around_action
+      #
+      # :call-seq: around_action(names, block)
+      #
+      # Append a callback around actions. See _insert_callbacks for parameter details.
+
+      ##
+      # :method: prepend_around_action
+      #
+      # :call-seq: prepend_around_action(names, block)
+      #
+      # Prepend a callback around actions. See _insert_callbacks for parameter details.
+
+      ##
+      # :method: skip_around_action
+      #
+      # :call-seq: skip_around_action(names)
+      #
+      # Skip a callback around actions. See _insert_callbacks for parameter details.
+
+      ##
+      # :method: append_around_action
+      #
+      # :call-seq: append_around_action(names, block)
+      #
+      # Append a callback around actions. See _insert_callbacks for parameter details.
+
+      # set up before_action, prepend_before_action, skip_before_action, etc.
+      # for each of before, after, and around.
+      [:before, :after, :around].each do |callback|
+        define_method "#{callback}_action" do |*names, &blk|
+          _insert_callbacks(names, blk) do |name, options|
+            set_callback(:call_action, callback, name, options)
+          end
+        end
+
+        define_method "prepend_#{callback}_action" do |*names, &blk|
+          _insert_callbacks(names, blk) do |name, options|
+            set_callback(:call_action, callback, name, options.merge(:prepend => true))
+          end
+        end
+
+        # Skip a before, after or around callback. See _insert_callbacks
+        # for details on the allowed parameters.
+        define_method "skip_#{callback}_action" do |*names|
+          _insert_callbacks(names) do |name, options|
+            skip_callback(:call_action, callback, name, options)
+          end
+        end
+
+        # *_action is the same as append_*_action
+        alias_method :"append_#{callback}_action", :"#{callback}_action"
+      end
+    end
+  end
+end

data/lib/simple_controller/core.rb

@@ -0,0 +1,28 @@
+module SimpleController
+  module Core
+    extend ActiveSupport::Concern
+
+    included do
+      attr_reader :params, :action_name
+    end
+
+    def call(action_name, params={})
+      @params ||= ActiveSupport::HashWithIndifferentAccess.new(params)
+      @action_name ||= action_name.to_s
+
+      call_action
+    end
+
+    protected
+
+    def call_action
+      public_send action_name
+    end
+
+    module ClassMethods
+      def call(*args)
+        new.call *args
+      end
+    end
+  end
+end

data/lib/simple_controller/engine.rb

@@ -0,0 +1,5 @@
+module SimpleController
+  class Engine < ::Rails::Engine
+    config.autoload_paths += %W[#{config.root}/lib/]
+  end
+end

data/lib/simple_controller/version.rb

@@ -0,0 +1,3 @@
+module SimpleController
+  VERSION = "0.1.0"
+end

data/simple_controller.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_controller/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_controller"
+  spec.version       = SimpleController::VERSION
+  spec.authors       = ["Steve Chung"]
+  spec.email         = ["hello@stevenchung.ca"]
+
+  spec.summary       = "Rails Controllers, but general purpose."
+  spec.homepage      = "https://github.com/FinalCAD/simple_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 "activesupport"
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: simple_controller
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steve Chung
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- hello@stevenchung.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_controller.rb
+- lib/simple_controller/base.rb
+- lib/simple_controller/callbacks.rb
+- lib/simple_controller/core.rb
+- lib/simple_controller/engine.rb
+- lib/simple_controller/version.rb
+- simple_controller.gemspec
+homepage: https://github.com/FinalCAD/simple_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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Rails Controllers, but general purpose.
+test_files: []