arcane 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+  - jruby-19mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head
+
+env:
+  - "strong_parameters=0.2.0"
+  - "strong_parameters=0.2.1"
+  - "activesupport=3.2.13"
+  - "activesupport=4.0.0"

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec # Specify your gem's dependencies in arcane.gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Philip Vieira
+
+MIT License
+
+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,32 @@
+# Arcane
+Easy to use parameter filter extending strong parameters.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'arcane'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install arcane
+```
+
+## Usage
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  #t.rspec_path = 'bin/rspec'
+  t.rspec_opts = %w[--color]
+end
+
+task :default => [:spec]

data/arcane.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'arcane/version'
+
+Gem::Specification.new do |gem|
+
+  gem.name          = "arcane"
+  gem.version       = Arcane::VERSION
+  gem.authors       = ["Philip Vieira", "Cloudsdale"]
+  gem.email         = ["philip@vallin.se"]
+
+  gem.description   = "Parameter filter done OO, extending strong parameters."
+  gem.summary       = "Extension for strong_parameters."
+  gem.homepage      = "https://github.com/cloudsdaleapp/arcane"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency             "activesupport",     ">= 3.0.0"
+  gem.add_dependency             "strong_parameters", ">= 0.2.0"
+
+  gem.add_development_dependency "activerecord", ">= 3.0.0"
+  gem.add_development_dependency "rspec",        "~>2.0"
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "rake"
+
+end

data/lib/arcane.rb

@@ -0,0 +1,28 @@
+require "arcane/version"
+require "arcane/finder"
+require "arcane/chain"
+require "arcane/refinery"
+
+require 'active_support/concern'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/object/blank'
+require 'strong_parameters'
+
+module Arcane
+
+  extend ActiveSupport::Concern
+
+  included do
+    if respond_to?(:helper_method)
+      helper_method :arcane
+    end
+    if respond_to?(:hide_action)
+      hide_action :arcane
+    end
+  end
+
+  def refine(object,*args)
+    Arcane::Chain.new(params,object,current_user)
+  end
+
+end

data/lib/arcane/chain.rb

@@ -0,0 +1,43 @@
+module Arcane
+
+  class Chain
+
+    attr_reader :_params, :_user, :_object, :_arcane, :_arcane_class
+
+    def initialize(_params,_object,_user)
+      @_user           = _user
+      @_object         = _object
+      @_params         = ActionController::Parameters.new(_params)
+      @_arcane_class = Arcane::Finder.new(_object).arcane
+      @_arcane       = @_arcane_class.new(_object,_user)
+    end
+
+    def method_missing(_arcane_method,*args)
+
+      if _arcane.respond_to?(_arcane_method)
+        _computed = _arcane.public_send(_arcane_method)
+      elsif _arcane.respond_to?(:default)
+        _computed = _arcane.default
+      else
+        _computed = []
+      end
+
+      if _arcane.respond_to?(:root)
+        _root = arcane.root
+      elsif _arcane_class.respond_to?(:root)
+        _root = _arcane_class.root
+      else
+        _root = Arcane::Finder.object_name(_object)
+      end
+
+      if _root.present?
+        _params.require(_root.parameterize).permit(*_computed)
+      else
+        _params.permit(*_computed)
+      end
+
+    end
+
+  end
+
+end

data/lib/arcane/finder.rb

@@ -0,0 +1,47 @@
+module Arcane
+
+  class Finder
+
+    attr_reader :object
+
+    def initialize(object)
+      @object = object
+    end
+
+    def arcane
+      klass = find
+      klass = klass.constantize if klass.is_a?(String)
+      klass
+    rescue NameError
+      Arcane::Refinery
+    end
+
+    def self.object_name(object)
+      klass = if object.respond_to?(:model_name)
+        object.model_name
+      elsif object.class.respond_to?(:model_name)
+        object.class.model_name
+      elsif object.is_a?(Class)
+        object
+      else
+        object.class
+      end
+      klass.to_s
+    end
+
+  private
+
+    def find
+      if object.respond_to?(:arcane_class)
+        object.arcane_class
+      elsif object.class.respond_to?(:arcane_class)
+        object.class.arcane_class
+      else
+        klass = self.class.object_name(object)
+        "#{klass}Refinery"
+      end
+    end
+
+  end
+
+end

data/lib/arcane/refinery.rb

@@ -0,0 +1,18 @@
+module Arcane
+
+  class Refinery
+
+    attr_reader :object, :user
+
+    def initialize(object,user=nil)
+      @object = object
+      @user   = user
+    end
+
+    def default
+      []
+    end
+
+  end
+
+end

data/lib/arcane/version.rb

@@ -0,0 +1,3 @@
+module Arcane
+  VERSION = "0.0.2"
+end

data/spec/arcane/chain_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Arcane::Chain do
+
+  let(:chain) { Arcane::Chain.new(params,object,user) }
+
+  let(:user)            { double }
+  let(:object)          { Article.new }
+  let(:arcane_class)  { ArticleRefinery }
+  let(:params)          { ActionController::Parameters.new(hash_params) }
+  let(:hash_params) do
+    {
+      article: {
+        title:   "hello",
+        content: "world",
+        links: [
+          { blog: "http://blog.example.com" },
+          { site: "http://www.example.com" },
+        ]
+      }
+    }
+  end
+
+  describe '.new' do
+
+    it 'sets attributes' do
+      chain._params.should         eq(params)
+      chain._object.should         eq(object)
+      chain._user.should           eq(user)
+      chain._arcane.should       be_a(arcane_class)
+      chain._arcane_class.should eq(arcane_class)
+    end
+
+    it 'converts the object to ActionController::Parameters' do
+      chain = Arcane::Chain.new(hash_params,object,user)
+      chain._params.should be_a ActionController::Parameters
+    end
+
+  end
+
+  describe '#method_missing' do
+
+    it 'returns the filtered parameters' do
+      chain.void_method.should be_a ActionController::Parameters
+    end
+
+    it 'filters the same as the default constraint' do
+      chain.void_method.should eq chain.default
+    end
+
+    context 'without root in params' do
+      let(:chain) { Arcane::Chain.new(params[:article],object,user) }
+      it 'raises an error' do
+        expect { chain.void_method }.to raise_error ActionController::ParameterMissing
+      end
+      it 'successds with nil root in arcane' do
+        arcane_class.stub(:root) { false }
+        expect { chain.void_method }.to_not raise_error
+        arcane_class.stub(:root) { nil }
+        expect { chain.void_method }.to_not raise_error
+      end
+    end
+
+  end
+
+end

data/spec/arcane/finder_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Arcane::Finder do
+
+  let(:object_with_arcane) { Task.new }
+  let(:object_without_arcane) { Shape.new }
+
+  before(:each) { @arcane = Arcane::Finder.new(object_with_arcane) }
+
+  describe '.new' do
+    it 'sets the object' do
+      @arcane.object.should eq(object_with_arcane)
+    end
+  end
+
+  describe '#find' do
+
+    it 'finds existing arcane' do
+      @arcane.send(:find).should eq "TaskRefinery"
+    end
+
+  end
+
+  describe '#arcane' do
+
+    it 'returns arcane' do
+      @arcane.arcane.should eq TaskRefinery
+    end
+
+    it 'returns base arcane class when no arcane exists' do
+      @arcane = Arcane::Finder.new(object_without_arcane)
+      @arcane.arcane.should eq Arcane::Refinery
+    end
+
+  end
+
+end

data/spec/arcane/refinery_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Arcane::Refinery do
+
+  let(:user) { double }
+  let(:object) { Article.new }
+
+  before(:each) do
+    @arcane = Arcane::Refinery.new(object,user)
+  end
+
+  describe '.new' do
+
+    it 'sets attributes' do
+      @arcane.object.should eq(object)
+      @arcane.user.should eq(user)
+    end
+
+    it 'does not set user if no user present' do
+      @arcane = Arcane::Refinery.new(object)
+      @arcane.user.should be_nil
+    end
+
+  end
+
+  describe '#default' do
+
+    it { @arcane.default.should be_empty }
+
+    it 'can be overridden when inherited' do
+      @arcane = ArticleRefinery.new(object,user)
+      @arcane.default.should eq [:title]
+    end
+
+  end
+
+end

data/spec/arcane_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Arcane do
+
+  let(:user)    { double }
+  let(:article) { Article.new }
+  let(:controller) { double(:current_user => user, :params => params).tap { |c| c.extend(Arcane) } }
+  let(:params) do
+    HashWithIndifferentAccess.new({
+      action: 'create',
+      article: {
+        title:   "hello",
+        content: "world",
+        links: [
+          { blog: "http://blog.example.com" },
+          { site: "http://www.example.com" },
+        ],
+        tags: ["test","greeting"]
+      }
+    })
+  end
+
+  describe '#refine' do
+
+    it { controller.refine(article).should be_a Arcane::Chain }
+    it { controller.refine(article).update.should be_a ActionController::Parameters }
+
+    it 'filters parameters correctly' do
+      controller.refine(article).update.should eq expected_params(:title,:content)
+    end
+
+    it 'filters nested object parameters correctly' do
+      controller.refine(article).create.should eq expected_params(:title,:content,:links)
+    end
+
+    it 'filters nested scalar parameters correctly' do
+      controller.refine(article).publish.should eq expected_params(:title,:content,:tags)
+    end
+
+  end
+
+end
+
+def expected_params(*includes)
+  params[:article].reject { |k,_| !includes.include? k.to_sym }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+require "arcane"
+require "pry"
+require "active_support/core_ext"
+require "active_model/naming"
+
+class Article; end
+class ArticleRefinery < Arcane::Refinery
+
+  def create
+    update + [ { links: [:blog, :site] } ]
+  end
+
+  def publish
+    update + [ { tags: [] } ]
+  end
+
+  def update
+    default + [:content]
+  end
+
+  def default
+    [:title]
+  end
+
+end
+
+class Task; end
+class TaskRefinery < Arcane::Refinery
+
+  def self.root
+    false
+  end
+
+end
+
+class Shape; end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: arcane
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Philip Vieira
+- Cloudsdale
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: strong_parameters
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Parameter filter done OO, extending strong parameters.
+email:
+- philip@vallin.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- arcane.gemspec
+- lib/arcane.rb
+- lib/arcane/chain.rb
+- lib/arcane/finder.rb
+- lib/arcane/refinery.rb
+- lib/arcane/version.rb
+- spec/arcane/chain_spec.rb
+- spec/arcane/finder_spec.rb
+- spec/arcane/refinery_spec.rb
+- spec/arcane_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/cloudsdaleapp/arcane
+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: -3172912698727836139
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3172912698727836139
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Extension for strong_parameters.
+test_files:
+- spec/arcane/chain_spec.rb
+- spec/arcane/finder_spec.rb
+- spec/arcane/refinery_spec.rb
+- spec/arcane_spec.rb
+- spec/spec_helper.rb