arcane 1.0.0.pre → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c157016d7b457a09a15c6222079d7d96725d8381
-  data.tar.gz: 90e1df401507d8c4281cf709580b23aebc72f958
+  metadata.gz: a862bb0fc096981789134db824772a2dab9355f8
+  data.tar.gz: e7e02551cda7792cc50bdfb18db771ec49d438a4
 SHA512:
-  metadata.gz: 75a7e859ce0552b16632bc9bc777cb3fcc621a7ef10403b6f9ceb24f91a39c96b7313c158908a28d8d8539c1556986c228f7b9c0dc817b26cd2a0c95a5559c91
-  data.tar.gz: d241c9243a4b3a194e92add373e31b56dd9a162f0631ad155ac287930a866e5abd7f1b8b63e8b8f5bb2c9203f5f21e31efbfceb8904d8566f6fd3845377e3abe
+  metadata.gz: a929d3ac3a2fdea27cc51fe56056fa5280bdc8c83a938a5ae6743202680f7ca269f3cb9b0c53eedf13ab0f727bdeff7d48488e0c4bae942eb2306c369d26b50d
+  data.tar.gz: 9a069440ffd9a1f4daf7450d33e7e704dd2c0d0171e5210d60093f94bc9a7cde7298b37a9ff1d34244548e8f2848ca077969a08ac598ce393d354e8b65291228

data/CHANGELOG.md

@@ -8,6 +8,11 @@
   refine your parameters. Look in `README.md` for
   detailed information.
 
+* **[feature]** Introducing most rails generators
+  to easily create generators for your class in the
+  command line. Read Look in `README.md` for
+  detailed information.
+
 * **[bugfix]** You can now properly specify
   `refinery_class` in your model.
 

data/README.md

@@ -11,6 +11,30 @@ in Rails 3 and 4.
 Arcane magic is real and reliable, no cheap tricks.
 Inspired by [Pundit](https://github.com/elabs/pundit)
 
+#### Breaking Changes - Check [CHANGELOG.md](https://github.com/cloudsdaleapp/arcane/blob/master/CHANGELOG.md)
+
+**This branch is showing a pre-release of Arcane, to install the this release, do this:**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "arcane", "~> 1.0.0"
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+To install arcane, execute:
+
+```bash
+rails g arcane:install
+```
+
 ## Usage
 
 This is how easy it is to use:
@@ -48,6 +72,11 @@ end
 Before you can use the parameter methods, 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`.
+You can also use the rails generator below:
+
+```bash
+rails g arcane:refinery article
+```
 
 Methods defined in the refinery should reflect the controller method for clarity, but can be anything you
 want it to be. These methods must return an array containing the same parameters you would otherwise send
@@ -100,8 +129,8 @@ class GameController < ApplicationController
   end
 
   def update
-    @article.find(params[:id])
-    @article.update_attributes params.for(@article).as(current_user).refine
+    @game.find(params[:id])
+    @game.update_attributes params.for(@game).as(current_user).refine
   end
 
   def update_many
@@ -127,13 +156,29 @@ the arcane methods. This is good if you have some other way of getting data in t
 the context of a controller.
 
 ```ruby
-  @user, @post = User.find(1), Post.find(24)
+@user, @post = User.find(1), Post.find(24)
+
+my_params = ActionController::Parameters.new({ post: { content: "Hello" } })
+my_params.for(@post).as(@user).on(:create)
+```
+
+If you want to delegate some behaviour to your model, you can always create your own constructor.
+
+```ruby
+class Post < ActiveRecord::Base
+  def self.refined_create(params)
+    create(params.for(self).refine)
+  end
+end
 
-  my_params = ActionController::Parameters.new({ post: { content: "Hello" } })
-  my_params.for(@post).as(@user).on(:create)
+class PostsController
+  def create
+    @post = Post.refined_create(params)
+  end
+end
 ```
 
-### Automatic Method Detection
+### Automatic method detection.
 If you have specified no refinery action in your chain to params, Arcane tries to find out for itself
 what method to use. Arcane uses the action key in the rails parameters to determine the refinery method.
 
@@ -152,7 +197,22 @@ class CommentRefinery < Arcane::Refinery
 end
 ```
 
-### Default parameters
+### Easily manage conditional parameters
+As an application grows larger, you usually want to filter what parameters based on some rules, usually
+by checking the role of your current user or the state of the object you want to set the parameters on.
+Arcane easily helps you do this.
+
+```ruby
+class UserRefinery < Arcane::Refinery
+  def update
+    params = [ { abuse_reports: AbuseReportRefinery.new(AbuseReport.new,user).create } ]
+    params += [:suspended]   if user.admin?
+    params += [:name,:email] if user.admin? or user == object
+  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. If default is not specified it will be as the refinery returned an empty array.
 
@@ -164,7 +224,7 @@ class AmbiguityRefinery < Arcane::Refinery
 end
 ```
 
-### Custom root requrement
+### Custom root requirement.
 You are able to disable or change the root requirement. Let's say you have a sessions endpoint where
 you don't have your username and password parameters wrapped in a root. Now you can use the root class
 method and set it to nil or false and it will automatically not require it.
@@ -189,7 +249,7 @@ class MeRefinery < UserRefinery
 end
 ```
 
-### Refinery Inheritence
+### Refinery inheritence.
 Say you have quite similar needs between two different models, one of them might even have inherited
 from the other. As arcane's refineries are just regular ruby models you can easily inherit from one
 to another and it will just work.
@@ -216,6 +276,19 @@ class CubeRefinery
 end
 ```
 
+### Building HATEOAS API templates
+As your refinery is a class that accepts an object and a user you can invoke it on it's own. This is
+really good if you want your application to generate endpoints under different scenarios dynamically.
+
+```ruby
+
+track_params = TrackRefinery.new(Track.new,User.new).create
+# => [:title,:description,:duration]
+
+track_url("{track}") + "?" + "{#{track_params.join(",")}}"
+# => "http://www.music.com/tracks/{track}?{title,desc,duration}"
+```
+
 ## Requirements
 
 Currently this gem is only supported for Rails and with any of these ruby versions:
@@ -226,30 +299,16 @@ Currently this gem is only supported for Rails and with any of these ruby versio
 * jruby-19
 * rbx-19
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'arcane'
-```
-
-And then execute:
-
-```bash
-$ bundle
-```
-
 ## To-do
 
-- [X] Explain Arcane::Refinery
-- [ ] Write rails generators
+- [x] Explain Arcane::Refinery
+- [x] Write rails generators
 - [x] List features
 - [x] Add Documentation
-- [ ] Add documentation for HATEOAS
-- [X] Automatic method detection
-- [ ] RSpec helpers to test Arcane
-- [ ] Configuration
+- [x] Add documentation for HATEOAS
+- [x] Automatic method detection
+- [-] RSpec helpers to test Arcane
+- [-] Configuration
 
 ## Contributing
 

data/lib/arcane/version.rb

@@ -1,3 +1,3 @@
 module Arcane
-  VERSION = "1.0.0.pre"
+  VERSION = "1.0.0"
 end

data/lib/generators/arcane/install/USAGE

@@ -0,0 +1,2 @@
+Description:
+    Generates an application refinery as a starting point for your application.

data/lib/generators/arcane/install/install_generator.rb

@@ -0,0 +1,13 @@
+module Arcane
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      def copy_application_refinery
+        template 'application_refinery.rb', 'app/refineries/application_refinery.rb'
+      end
+
+    end
+  end
+end

data/lib/generators/arcane/install/templates/application_refinery.rb

@@ -0,0 +1,5 @@
+class ApplicationRefinery < Arcane::Refinery
+  # Shared functionality for refineries,
+  # unless inherited this class will not
+  # do anything.
+end

data/lib/generators/arcane/refinery/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a refinery for a model with the given name.
+
+Example:
+    rails generate arcane:refinery user
+
+    This will create:
+        app/refineries/user_refinery.rb

data/lib/generators/arcane/refinery/refinery_generator.rb

@@ -0,0 +1,13 @@
+module Arcane
+  module Generators
+    class RefineryGenerator < ::Rails::Generators::NamedBase
+
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      def create_policy
+        template 'refinery.rb', File.join('app/refineries', class_path, "#{file_name}_refinery.rb")
+      end
+
+    end
+  end
+end

data/lib/generators/arcane/refinery/templates/refinery.rb

@@ -0,0 +1,11 @@
+<% module_namespacing do -%>
+class <%= class_name %>Refinery < ApplicationRefinery
+
+  def create
+  end
+
+  def update
+  end
+
+end
+<% end -%>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arcane
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre
+  version: 1.0.0
 platform: ruby
 authors:
 - Philip Vieira
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-12 00:00:00.000000000 Z
+date: 2013-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -116,6 +116,12 @@ files:
 - lib/arcane/parameters.rb
 - lib/arcane/refinery.rb
 - lib/arcane/version.rb
+- lib/generators/arcane/install/USAGE
+- lib/generators/arcane/install/install_generator.rb
+- lib/generators/arcane/install/templates/application_refinery.rb
+- lib/generators/arcane/refinery/USAGE
+- lib/generators/arcane/refinery/refinery_generator.rb
+- lib/generators/arcane/refinery/templates/refinery.rb
 - spec/arcane/finder_spec.rb
 - spec/arcane/parameters_spec.rb
 - spec/arcane/refinery_spec.rb
@@ -136,9 +142,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.3