arcane 0.1.0 → 0.1.1

data/CHANGELOG.md

@@ -1,9 +1,14 @@
-### Arcane **0.1.0** [head] – 2013-07-11
+### Arcane **0.1.1** [head] – 2013-07-11
+* **[feature]** The `refine` helper no longer needs a
+  refinery method, it will try and detect which one to
+  use based on parameters.
+
+### Arcane **0.1.0** [current] – 2013-07-11
 * **[bugfix]** Arcane should no longer error when there is
   no current_user present.
 * **[feature]** Added new query syntax for the `refine`
   helper. It now supports custom params and/or refinery
   keys to be sent as arguments.
 
-### Arcane **0.0.3** [current] – 2013-07-11
+### Arcane **0.0.3** [old] – 2013-07-11
 * Initial Release

data/README.md

@@ -3,16 +3,26 @@
 [![Build Status](https://travis-ci.org/cloudsdaleapp/arcane.png?branch=master)](https://travis-ci.org/cloudsdaleapp/arcane)
 [![Gem Version](https://badge.fury.io/rb/arcane.png)](http://badge.fury.io/rb/arcane)
 
-Easy to use parameter filter extending [Strong Parameters](https://github.com/rails/strong_parameters).
-Arcane provides you with helpers which guide you in leveraging regular Ruby classes and object oriented
-design patterns to organise and easily harnass the power of strong parameters in Rails 3 and 4.
+Easy to use parameter management, extending [Strong Parameters](https://github.com/rails/strong_parameters),
+making them a first class citizen. Arcane provides you with helpers which guide you in leveraging regular
+Ruby classes and object oriented design patterns to organise and easily harnass the power of strong parameters
+in Rails 3 and 4.
 
 Arcane magic is real and reliable, no cheap tricks.
 Inspired by [Pundit](https://github.com/elabs/pundit)
 
 ## Usage
 
-First of all, include `Arcane` in your controller. This will give you access to the `refine` helper.
+This is how easy it will be:
+
+```ruby
+@article = Article.new refine(Article, :create)
+```
+
+### Include the Helper
+
+Though, we need to do a couple of things before we can get started. First of all include `Arcane` in your
+controller. This will give you access to the `refine` helper.
 
 ```ruby
 # app/controllers/application_controller.rb
@@ -21,6 +31,8 @@ class ApplicationController < ActionController::Base
 end
 ```
 
+### Create your first Refinery
+
 Before you can use the `refine` helper, you need a Refinery for the model you want to pass parameters to.
 Simply create the directory `/app/refineries` in your Rails project. Create a Refinery your model, in this
 case Article. `/app/refineries/article_refinery.rb`. Create a class in that file called `ArticleRefinery`.
@@ -29,9 +41,13 @@ Methods defined in the refinery should reflect the controller method for clarity
 want it to be. These methods must return an array containing the same parameters you would otherwise send
 to strong parameters.
 
+It can be initiated using a `Struct` which accepts an `object` and a `user`. The `refine` method will
+automatically send `current_user`, if present to the refinery as well as the object you want to apply
+the parameters on.
+
 ```ruby
 # app/refineries/article_refinery.rb
-class ArticleRefinery < Arcane::Refinery
+class ArticleRefinery < Struct.new(:object,:user)
   def create
     [:title] + update
   end
@@ -41,6 +57,15 @@ class ArticleRefinery < Arcane::Refinery
 end
 ```
 
+**Note**, for convenience sake there is a class called `Arcane::Refinery` which you can use instead of
+the struct. This class gives you the basic functionality of a refinery for free.
+
+```ruby
+class CommentRefinery < Arcane::Refinery; end
+```
+
+### Using Arcane in your controller
+
 Next up, using the `refine` helper. The helper can be called from anywhere in your controller and views
 and accepts one parameter, the object for which you want to *refine* the parameters, then followed by
 calling the method for what parameters you want.
@@ -80,10 +105,23 @@ having to worry which order you put them in as long as the permit object is the
   refine(@article,:update,my_params)
 ```
 
+### Automatic Method Detection
+If you have specified no refinery method in your call to `refine`, Arcane tries to find out for itself
+what method to use. If you send the params in from a rails controller, Arcane will use the `action` key
+on the parameters and use your refinery. *If you want to know how to handle fallbacks, see next feature.*
+
+```ruby
+class CommentsController < ApplicationController
+  def update
+    @comment = Comment.find(params[:id])
+    @comment.update_attributes refine @comment
+  end
+end
+```
+
 ### Default Parameters
 You are able to specify a `default` method in your refinery which will be prioritized if no the method
-you call does not exist. **While you should probably never put yourself in this situation**, the feature
-is available for those edge case scenarios where you need it.
+you call does not exist. If default is not specified it will be as the refinery returned an empty array.
 
 ```ruby
 class AmbiguityRefinery < Arcane::Refinery
@@ -144,11 +182,14 @@ $ bundle
 
 ## To-do
 
+- [X] Explain Arcane::Refinery
 - [ ] Write rails generators
 - [x] List features
 - [x] Add Documentation
 - [ ] Add documentation for HATEOAS
-- [ ] Automatic method detection
+- [X] Automatic method detection
+- [ ] RSpec helpers to test Arcane
+- [ ] Configuration
 
 ## Contributing
 

data/arcane.gemspec

@@ -13,7 +13,8 @@ Gem::Specification.new do |gem|
   gem.description   = "Parameter filter done OO, extending strong parameters."
   gem.summary       = "Extension for strong_parameters."
   gem.homepage      = "https://github.com/cloudsdaleapp/arcane"
-
+  gem.license       = "MIT"
+  
   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)/})
@@ -27,4 +28,4 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "pry"
   gem.add_development_dependency "rake"
 
-end
+end

data/lib/arcane.rb

@@ -37,6 +37,7 @@ module Arcane
       end
     end
 
+    opts[:method] ||= params[:action]
     opts[:params] ||= params
     opts[:user]   ||= current_user
     opts[:object] ||= object.respond_to?(:new) ? object.new : object

data/lib/arcane/version.rb

@@ -1,3 +1,3 @@
 module Arcane
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/arcane_spec.rb

@@ -4,10 +4,10 @@ describe Arcane do
 
   let(:user)    { double }
   let(:article) { Article.new }
+  let(:comment) { Comment.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",
@@ -34,27 +34,67 @@ describe Arcane do
     it { controller.refine(article).update.should be_a ActionController::Parameters }
     it { controller.refine(Article)._object.should be_a Article }
 
+    context 'without supplying a refinery method' do
+
+      let(:params) do
+        HashWithIndifferentAccess.new({
+          action: 'create',
+          comment: {
+           content: "Awesome!",
+           score: 5
+          }
+        })
+      end
+
+      it 'still returns a parameters hash' do
+        controller.refine(comment).should be_a ActionController::Parameters
+      end
+
+      it 'finds the right method' do
+        controller.refine(comment).should eq expected_params(:comment,:score,:content)
+      end
+
+      context 'using a missing refinery method' do
+
+        let(:params) do
+          HashWithIndifferentAccess.new({
+            action: 'update',
+            comment: {
+             content: "Awesome!",
+             score: 5
+            }
+          })
+        end
+
+        it 'falls back on default' do
+          controller.refine(comment).should eq expected_params(:comment,:score)
+        end
+
+      end
+
+    end
+
     it 'filters parameters correctly' do
-      controller.refine(article).update.should eq expected_params(:title,:content)
+      controller.refine(article).update.should eq expected_params(:article,:title,:content)
     end
 
     it 'filters nested object parameters correctly' do
-      controller.refine(article).create.should eq expected_params(:title,:content,:links)
+      controller.refine(article).create.should eq expected_params(:article,:title,:content,:links)
     end
 
     it 'filters nested scalar parameters correctly' do
-      controller.refine(article).publish.should eq expected_params(:title,:content,:tags)
+      controller.refine(article).publish.should eq expected_params(:article,:title,:content,:tags)
     end
 
     it 'filters custom parameters correctly' do
-      controller.refine(article,custom_params,:publish).should eq expected_params(:tags)
-      controller.refine(article,:publish,custom_params).should eq expected_params(:tags)
+      controller.refine(article,custom_params,:publish).should eq expected_params(:article,:tags)
+      controller.refine(article,:publish,custom_params).should eq expected_params(:article,:tags)
     end
 
   end
 
 end
 
-def expected_params(*includes)
-  params[:article].reject { |k,_| !includes.include? k.to_sym }
+def expected_params(object_name,*includes)
+  params[object_name].reject { |k,_| !includes.include? k.to_sym }
 end

data/spec/spec_helper.rb

@@ -33,4 +33,17 @@ class TaskRefinery < Arcane::Refinery
 
 end
 
-class Shape; end
+class Shape; end
+
+class Comment; end
+class CommentRefinery < Arcane::Refinery
+
+  def create
+    [:content,:score]
+  end
+
+  def default
+    [:score]
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arcane
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -135,7 +135,8 @@ files:
 - spec/arcane_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/cloudsdaleapp/arcane
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -148,7 +149,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2536535515859705955
+      hash: 1025235848978620495
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -157,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2536535515859705955
+      hash: 1025235848978620495
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25