resourced 0.0.1.beta1 → 0.1.0

data/.travis.yml

@@ -1,6 +1,7 @@
 rvm:
   - 1.9.2
   - 1.9.3
+  - 2.0.0
   - rbx-19mode
   - jruby-19mode
 

data/Gemfile

@@ -5,6 +5,17 @@ gemspec
 
 group :test do
   gem "rake"
-  gem "sqlite3"
-  gem "activerecord"
+  gem "activerecord", "~> 3.2"
+end
+
+platforms :ruby do
+  group :test do
+    gem "sqlite3"
+  end
+end
+
+platforms :jruby do
+  group :test do
+    gem "activerecord-jdbcsqlite3-adapter"
+  end
 end

data/README.md

@@ -10,11 +10,13 @@ class PostResource
   include Resourced::ActiveRecord
 
   model Post
-  key :id
+  body  :post
+  key   :id
 
-  params do
-    allow :title, :body, :tags
-    allow :category, if: -> { scope.admin? }
+  attributes do
+    allow :title, :body
+    allow :tags, as: :array
+    allow :category, as: :string, if: -> { scope.admin? }
   end
 
   finders do
@@ -27,6 +29,10 @@ class PostResource
     finder :search do |val|
       chain.where(t[:body].matches("%#{val}%"))
     end
+
+    finder :limit, as: :integer, default: 20 do |val|
+      chain.limit(20)
+    end
   end
 end
 ```
@@ -54,7 +60,7 @@ posts.all # Will return all posts which contains "Atlas Shrugged" unless current
 
 Add this line to your application's Gemfile:
 
-    gem 'resourced'
+    gem 'resourced', '~> 0.1'
 
 And then execute:
 
@@ -66,6 +72,21 @@ Or install it yourself as:
 
 ## Usage
 
+### Creating Resources
+
+If you are using rails, your resource files will be automatically generated with models or resources.
+
+```
+rails generate resource Something field1:string field2:integer
+```
+
+You can also generate resource file manually:
+```
+rails generate resourced Something field1:string field2:integer
+```
+
+This will create folder `app/resources` if not exists, and basic resource file.
+
 ## Contributing
 
 1. Fork it

data/lib/generators/rails/resourced_generator.rb

@@ -0,0 +1,32 @@
+require 'rails/generators/named_base'
+
+module Rails
+  module Generators
+
+    class ResourcedGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+      check_class_collision :suffix => "Resource"
+
+      argument :attributes, :type => :array, :default => [], :banner => "field[:type][:index] field[:type][:index]"
+
+      def create_resourced_file
+        template "resource.rb", File.join("app/resources", class_path, "#{file_name}_resource.rb")
+      end
+
+      hook_for :test_framework
+
+    protected
+
+      def accessible_attributes
+        attributes.reject(&:reference?)
+      end
+
+      def type_for(attr)
+        type = attr.type
+        type = :string if type == :text
+        type
+      end
+    end
+
+  end
+end

data/lib/generators/rails/templates/resource.rb

@@ -0,0 +1,17 @@
+class <%= class_name %>Resource
+  include Resourced::ActiveRecord
+
+  model <%= class_name %>
+  body :<%= singular_name %>
+  key  :id
+
+  attributes do
+  <% accessible_attributes.each do |attr| -%>
+  allow :<%= attr.name %>, as: :<%= type_for(attr) %>
+  <% end -%>
+end
+
+  finders do
+    
+  end
+end

data/lib/generators/resource_override.rb

@@ -0,0 +1,13 @@
+# Taken from draper gem https://github.com/drapergem/draper/
+require "rails/generators"
+require "rails/generators/rails/resource/resource_generator"
+
+module Rails
+  module Generators
+    ResourceGenerator.class_eval do
+      def add_resource
+        invoke "resourced"
+      end
+    end
+  end
+end

data/lib/generators/rspec/resourced_generator.rb

@@ -0,0 +1,9 @@
+module Rspec
+  class ResourcedGenerator < ::Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_spec_file
+      template 'resource_spec.rb', File.join('spec/resources', class_path, "#{file_name}_resource_spec.rb")
+    end
+  end
+end

data/lib/generators/rspec/templates/resource_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe <%= class_name %>Resource do
+end

data/lib/generators/test_unit/resourced_generator.rb

@@ -0,0 +1,9 @@
+module TestUnit
+  class ResourcedGenerator < ::Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_test_file
+      template 'resource_test.rb', File.join('test/resources', class_path, "#{file_name}_resource_test.rb")
+    end
+  end
+end

data/lib/generators/test_unit/templates/resource_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class <%= class_name %>ResourceTest
+end

data/lib/resourced.rb

@@ -1,23 +1,23 @@
 require "resourced/version"
-require "resourced/params"
+require "resourced/attributes"
 require "resourced/finders"
+require "resourced/railtie" if defined?(Rails)
 
 module Resourced
-  module Facade
+  module Resource
     module InstanceMethods
-      def initialize(params, scope)
+      def initialize(params, scope=nil)
         @scope = scope
         @model = self.class.instance_variable_get(:@model)
         @key   = self.class.instance_variable_get(:@key)
         @chain = @model
         super
-        @body  = @params.keep_if { |k, v| attribute_names.include?(k) }
       end
-      attr_accessor :params, :scope
+      attr_accessor :scope
       attr_reader   :model, :chain, :key
 
       ##
-      # Run external code in context of facade
+      # Run external code in context of resource
       #
       # Examples:
       #
@@ -45,7 +45,7 @@ module Resourced
       end
 
       ##
-      # Duplicate facade and set another model class
+      # Duplicate resource and set another model class
       #
       def [](model_class)
         klass = self.dup
@@ -62,7 +62,7 @@ module Resourced
     end
 
     def self.included(base)
-      base.send(:include, Resourced::Params)
+      base.send(:include, Resourced::Attributes)
       base.send(:include, Resourced::Finders)
       base.send(:include, InstanceMethods)
       base.extend ClassMethods

data/lib/resourced/active_record.rb

@@ -1,5 +1,4 @@
 require "resourced"
-require "resourced/active_record/meta"
 require "resourced/active_record/proxy"
 require "resourced/active_record/actions"
 
@@ -25,8 +24,7 @@ module Resourced
     end
 
     def self.included(base)
-      base.send(:include, Resourced::Facade)
-      base.send(:include, Meta)
+      base.send(:include, Resourced::Resource)
       base.send(:include, Proxy)
       base.send(:include, Actions)
       base.extend ClassMethods

data/lib/resourced/active_record/actions.rb

@@ -3,14 +3,14 @@ module Resourced
 
     module Actions
       def build
-        model.new(@body)
+        model.new(@attributes)
       end
 
       def update
-        body = @body.reject { |k,_| k == :id }
+        body = @attributes.reject { |k,_| k == :id }
 
-        collection = if params[key]
-          [model.find(params[key])]
+        collection = if attributes[key]
+          [model.find(attributes[key])]
         else
           all
         end
@@ -22,10 +22,10 @@ module Resourced
       end
 
       def update!
-        body = @body.reject { |k,_| k == :id }
+        body = @attributes.reject { |k,_| k == :id }
 
-        collection = if params[key]
-          [model.find(params[key])]
+        collection = if @attributes[key]
+          [model.find(@attributes[key])]
         else
           all
         end

data/lib/resourced/{params.rb → attributes.rb}

@@ -1,12 +1,14 @@
-require "active_support/core_ext/array"
+require "coercible"
 
 module Resourced
-  module Params
+  module Attributes
 
     module InstanceMethods
       def initialize(params, scope)
-        set(params)
+        @attr_body = self.class.body
+        set(@attr_body ? params[@attr_body] : params)
       end
+      attr_reader :attributes, :attr_body
 
       ##
       # Set additional params
@@ -20,12 +22,12 @@ module Resourced
       #     resource.set(role: "guest")
       #
       def set(params={})
-        sanitized = self.class._params_obj.sanitize_params(self, params)
+        sanitized = self.class._attributes_obj.sanitize_params(self, params)
 
-        if @params
-          @params.merge(sanitized)
+        if @attributes
+          @attributes.merge(sanitized)
         else
-          @params = sanitized
+          @attributes = sanitized
         end
 
         self
@@ -44,21 +46,16 @@ module Resourced
       #
       def erase(*keys)
         keys.each do |key|
-          @params.delete(key.to_sym)
+          @attributes.delete(key.to_sym)
         end
 
         self
       end
-
-    protected
-
-      def params
-        @params
-      end
     end
 
     class RuleSet
       def initialize
+        @types                   = {}
         @defaults                = {}
         @conditional_allows      = []
         @unconditional_allows    = []
@@ -80,7 +77,7 @@ module Resourced
       #     allow :role, default: "guest"
       #
       def allow(*fields)
-        opts = fields.extract_options! # AS
+        opts = extract_options(fields)
 
         if opts[:if]
           @conditional_allows << ConditionalGroup.new(opts[:if], fields)
@@ -88,6 +85,12 @@ module Resourced
           @unconditional_allows += fields
         end
 
+        if as = opts[:as]
+          fields.each do |field|
+            @types[field] = :"to_#{as}"
+          end
+        end
+
         if opts[:default]
           fields.each do |field|
             @defaults[field] = opts[:default]
@@ -108,7 +111,7 @@ module Resourced
       #     restrict :role, if: -> { scope !== :admin }
       #
       def restrict(*fields)
-        opts = fields.extract_options! # AS
+        opts = extract_options(fields)
 
         if opts[:if]
           @conditional_restricts << ConditionalGroup.new(opts[:if], fields)
@@ -138,7 +141,27 @@ module Resourced
           end
         end
 
-        @defaults.merge(params).symbolize_keys.keep_if { |k, v| allowed_params.include?(k) } # AS
+        result = {}
+        coercer = Coercible::Coercer.new unless @types.empty?
+
+        @defaults.merge(params).each do |k, v|
+          k = k.to_sym
+
+          if allowed_params.include?(k)
+            result[k] = @types[k] ? coercer[v.class].public_send(@types[k], v) : v
+          end
+        end
+
+        result
+      end
+
+    private
+      def extract_options(args)
+        if args.last.is_a?(Hash)
+          args.pop
+        else
+          {}
+        end
       end
     end
 
@@ -162,18 +185,22 @@ module Resourced
     end
 
     module ClassMethods
-      def params(&block)
-        @_params_obj ||= RuleSet.new
-        @_params_obj.instance_eval(&block)
+      def attributes(&block)
+        @_attributes_obj ||= RuleSet.new
+        @_attributes_obj.instance_eval(&block)
+      end
+
+      def body(name=nil)
+        name ? @attr_body = name : @attr_body
       end
 
-      attr_reader :_params_obj
+      attr_reader :_attributes_obj
     end
 
     include InstanceMethods
 
     def self.included(base)
-      base.extend  ClassMethods
+      base.extend ClassMethods
     end
   end
 end

data/lib/resourced/finders.rb

@@ -1,8 +1,8 @@
-require "resourced/params"
+require "resourced/attributes"
 
 module Resourced
   module Finders
-    class Finders < Resourced::Params::RuleSet
+    class Finders < Resourced::Attributes::RuleSet
       def initialize
         super
         @finders = {}
@@ -40,15 +40,16 @@ module Resourced
       def initialize(params, scope)
         super
         @finders_obj = self.class.instance_variable_get(:@_finders_obj)
-        @finders = @finders_obj.sanitize_params(chain, params)
+        @finders = @finders_obj.sanitize_params(self, params)
+      end
+      attr_reader :finders
 
+      def apply_finders
         defaults = self.class.instance_variable_get(:@_default_finders)
         defaults.each do |finder|
-          context(&finder)
+          @chain = self.instance_eval(&finder)
         end
-      end
 
-      def apply_finders
         @finders.each_pair do |key, value|
           @chain = self.instance_exec(value, &@finders_obj.finders[key.to_sym])
         end
@@ -60,11 +61,12 @@ module Resourced
     module ClassMethods
       def finders(&block)
         @_finders_obj ||= Finders.new
-        @_finders_obj.instance_eval(&block)
+        @_finders_obj.instance_eval(&block) if block_given?
       end
       attr_reader :_finders_obj
 
       def default_finder(&block)
+        finders
         @_default_finders << block if block_given?
       end
     end

data/lib/resourced/railtie.rb

@@ -0,0 +1,21 @@
+require "rails/railtie"
+require "resourced/active_record"
+
+module ActiveModel
+  class Railtie < Rails::Railtie
+    generators do |app|
+      app ||= Rails.application # Rails 3.0.x does not yield `app`
+
+      Rails::Generators.configure! app.config.generators
+      require "generators/resource_override"
+    end
+  end
+end
+
+module Resourced
+  class Railtie < Rails::Railtie
+    config.after_initialize do |app|
+      app.config.paths.add "app/resources", eager_load: true
+    end
+  end
+end

data/lib/resourced/version.rb

@@ -1,3 +1,3 @@
 module Resourced
-  VERSION = "0.0.1.beta1"
+  VERSION = "0.1.0"
 end

data/resourced.gemspec

@@ -16,6 +16,6 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "active_support"
+  gem.add_dependency "coercible"
   gem.add_development_dependency "rspec"
 end

data/spec/resourced/adapters/active_record_spec.rb

@@ -22,7 +22,7 @@ describe Resourced::ActiveRecord do
       model User
       key :id
 
-      params do
+      attributes do
         allow :name, :email
         allow :role, :if => lambda { scope == "admin" }
       end

data/spec/resourced/{params_spec.rb → attributes_spec.rb}

@@ -1,34 +1,34 @@
 require "spec_helper"
 
-describe Resourced::Params do
-  class ParamsTest
-    include Resourced::Params
+describe Resourced::Attributes do
+  class AttributesTest
+    include Resourced::Attributes
 
-    def initialize(params, scope)
+    def initialize(params, scope=nil)
       @scope = scope
       super
     end
-    attr_reader :params
+    attr_reader :attributes
   end
 
   params = { :a => 1, :b => 2, :c => 3, :d => 4 }
 
   describe "Unconditional allows" do
-    klass = ParamsTest.dup
-    klass.params do
+    klass = AttributesTest.dup
+    klass.attributes do
       allow :a, :b, :c
     end
     inst = klass.new(params, "admin")
 
     it "should contain only allowed" do
-      inst.params.keys.should eq([:a, :b, :c])
+      inst.attributes.keys.should eq([:a, :b, :c])
     end
   end
 
   describe "Conditional allows" do
-    klass = ParamsTest.dup
+    klass = AttributesTest.dup
 
-    klass.params do
+    klass.attributes do
       allow :a, :b, :c
       allow :d, :if => lambda { @scope == "admin" }
     end
@@ -37,7 +37,7 @@ describe Resourced::Params do
       inst = klass.new(params, "admin")
 
       it "should contain conditional param" do
-        inst.params.keys.should eq([:a, :b, :c, :d])
+        inst.attributes.keys.should eq([:a, :b, :c, :d])
       end
     end
 
@@ -45,27 +45,27 @@ describe Resourced::Params do
       inst = klass.new(params, "guest")
 
       it "should not contain conditional param" do
-        inst.params.keys.should eq([:a, :b, :c])
+        inst.attributes.keys.should eq([:a, :b, :c])
       end
     end
   end
 
   describe "Unconditional restricts" do
-    klass = ParamsTest.dup
-    klass.params do
+    klass = AttributesTest.dup
+    klass.attributes do
       allow :a, :b, :c
       restrict :c
     end
     inst = klass.new(params, "admin")
 
     it "should not contain restricted" do
-      inst.params.keys.should eq([:a, :b])
+      inst.attributes.keys.should eq([:a, :b])
     end
   end
 
   describe "Conditional restricts" do
-    klass = ParamsTest.dup
-    klass.params do
+    klass = AttributesTest.dup
+    klass.attributes do
       allow :a, :b, :c
       restrict :c, :if => lambda { @scope != "admin" }
     end
@@ -74,7 +74,7 @@ describe Resourced::Params do
       inst = klass.new(params, "guest")
 
       it "should not contain conditional param" do
-        inst.params.keys.should eq([:a, :b])
+        inst.attributes.keys.should eq([:a, :b])
       end
     end
 
@@ -82,8 +82,35 @@ describe Resourced::Params do
       inst = klass.new(params, "admin")
 
       it "should contain conditional param" do
-        inst.params.keys.should eq([:a, :b, :c])
+        inst.attributes.keys.should eq([:a, :b, :c])
       end
     end
   end
+
+  describe "Attribute body" do
+    klass = AttributesTest.dup
+    klass.body :test
+    klass.attributes do
+      allow :a, :b
+    end
+    inst = klass.new({ :test => params })
+
+    it "should get attributes from given body" do
+      inst.attributes.keys.should eq([:a, :b])
+    end
+  end
+
+  describe "Coercions" do
+    klass = AttributesTest.dup
+    klass.attributes do
+      allow :a, :as => :boolean
+      allow :b, :as => :integer
+    end
+    inst = klass.new({ :a => "0", :b => "7" })
+
+    it "should coerce params" do
+      inst.attributes[:a].should be_false
+      inst.attributes[:b].should eql(7)
+    end
+  end
 end

data/spec/resourced/finders_spec.rb

@@ -78,4 +78,17 @@ describe Resourced::Finders do
     end
   end
 
+  describe "Default finder" do
+    before :each do
+      klass.default_finder do
+        chain.default("foo")
+      end
+    end
+    let(:params) { {} }
+
+    it "should apply default finder" do
+      inst.apply_finders.chain.result.should eq("#default(foo)")
+    end
+  end
+
 end

data/spec/resourced/resource_spec.rb

@@ -0,0 +1,104 @@
+require "spec_helper"
+
+describe Resourced::Resource do
+  class ResourceModel
+    def initialize
+      @result = ""
+    end
+    attr_reader :result
+
+    def method_missing(name, value)
+      @result += "##{name}(#{value})"
+      self
+    end
+
+    class << self
+      def title(value)
+        self.new.title(value)
+      end
+
+      def email(value)
+        self.new.email(value)
+      end
+    end
+  end
+
+  class TestResource
+    include Resourced::Resource
+
+    model ResourceModel
+    key :id
+
+    attributes do
+      allow :a, :b
+      allow :c, :if => lambda { scope == :admin }
+      restrict :b, :if => lambda { scope != :admin }
+    end
+
+    finders do
+      finder :title do |v|
+        chain.title(v)
+      end
+
+      finder :email, :if => lambda { scope == :admin } do |v|
+        chain.email(v)
+      end
+    end
+  end
+
+  describe "Context independent properties" do
+    let(:inst) { TestResource.new({}, :admin) }
+
+    it "should store pkey" do
+      inst.key.should eq(:id)
+    end
+
+    it "should store model" do
+      inst.model.should eq(ResourceModel)
+    end
+
+    it "should store scope" do
+      inst.scope.should eq(:admin)
+    end
+  end
+
+  describe "Chain" do
+    let(:inst) { TestResource.new({ :title => "John", :email => "test@test.com" }, role) }
+
+    context "when scope not match" do
+      let(:role) { :guest }
+
+      it "should apply finders to the chain" do
+        inst.apply_finders.chain.result.should eq("#title(John)")
+      end
+
+      it "should not rewrite model" do
+        inst.apply_finders.model.should eq(ResourceModel)
+      end
+    end
+
+    context "when scope is match" do
+      let(:role) { :admin }
+
+      it "should apply finders to the chain" do
+        inst.apply_finders.chain.result.should eq("#title(John)#email(test@test.com)")
+      end
+    end
+  end
+
+  describe "Attributes" do
+    let(:inst) { TestResource.new({ :a => "a", :b => "b", :c => "c" }, :user) }
+
+    it "should filter attributes" do
+      inst.attributes.should eq({ :a => "a"})
+    end
+  end
+
+  describe "Finders" do
+    let(:inst) { TestResource.new({ :title => "John", :email => "test@test.com" }) }
+
+    it "should filter finders" do
+      inst.finders.keys.should eq([:title])
+    end
+  end
+end

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: resourced
 version: !ruby/object:Gem::Version
-  version: 0.0.1.beta1
-  prerelease: 6
+  version: 0.1.0
+  prerelease: 
 platform: ruby
 authors:
 - Andrey Savchenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-14 00:00:00.000000000 Z
+date: 2013-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: active_support
+  name: coercible
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -57,18 +57,26 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/rails/resourced_generator.rb
+- lib/generators/rails/templates/resource.rb
+- lib/generators/resource_override.rb
+- lib/generators/rspec/resourced_generator.rb
+- lib/generators/rspec/templates/resource_spec.rb
+- lib/generators/test_unit/resourced_generator.rb
+- lib/generators/test_unit/templates/resource_test.rb
 - lib/resourced.rb
 - lib/resourced/active_record.rb
 - lib/resourced/active_record/actions.rb
-- lib/resourced/active_record/meta.rb
 - lib/resourced/active_record/proxy.rb
+- lib/resourced/attributes.rb
 - lib/resourced/finders.rb
-- lib/resourced/params.rb
+- lib/resourced/railtie.rb
 - lib/resourced/version.rb
 - resourced.gemspec
 - spec/resourced/adapters/active_record_spec.rb
+- spec/resourced/attributes_spec.rb
 - spec/resourced/finders_spec.rb
-- spec/resourced/params_spec.rb
+- spec/resourced/resource_spec.rb
 - spec/spec_helper.rb
 - spec/support/active_record.rb
 homepage: https://github.com/Ptico/resourced
@@ -86,9 +94,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -97,7 +105,8 @@ specification_version: 3
 summary: Missing layer between model and controller
 test_files:
 - spec/resourced/adapters/active_record_spec.rb
+- spec/resourced/attributes_spec.rb
 - spec/resourced/finders_spec.rb
-- spec/resourced/params_spec.rb
+- spec/resourced/resource_spec.rb
 - spec/spec_helper.rb
 - spec/support/active_record.rb

data/lib/resourced/active_record/meta.rb

@@ -1,15 +0,0 @@
-module Resourced
-
-  module ActiveRecord
-    module Meta
-      def attributes
-        @attributes ||= Hash[model.columns.map{ |c| [c.name.to_sym, c.type] }]
-      end
-
-      def attribute_names
-        attributes.keys
-      end
-    end
-  end
-
-end