resources 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36863daefb238f15a3d9f0ad1a9ecd59e1cbdf30
+  data.tar.gz: face9855059f06f5321be5188c3141c95903424c
+SHA512:
+  metadata.gz: 2eb85882c8de98dd5a1b0e34f41e74b7609d7465ed502c482980c5081f4f142c477825a58ad85fcc78fcf656417f7797a3aa7523a9a272d835d988f4322314fe
+  data.tar.gz: f56fac3ea48fe486a18b07a39b0dcaac534e393cdbc348d0e7e710dcd2b18acf1cb910d60aae9a37c167df035b4c6f07532a899197e6754c853698fbab05c92a

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright 2015 Emilio Forrer
+
+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,230 @@
+**Resources**
+===================
+
+It's a gem that help's you to create **CRUD** controllers for your models in a **very fast** and **flexible** way.
+
+----------
+
+
+**Installation**
+------------
+
+
+
+Add this line to your application's Gemfile:
+
+```
+gem 'resources'
+```
+
+And then execute:
+
+```
+bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install resources
+```
+
+Rub the configuration generator, this will create the **resources initializer**
+
+```
+rails g resources:install
+```
+ 
+ ----------
+
+USAGE
+-------------
+ 
+ Just add `resource_for` to your controller and give the model's name
+
+```
+class Admin::CountriesController < ApplicationController
+  resource_for "Country"
+end
+```
+
+or use the controller generator
+
+```
+rails g resource_controller admin/country
+```
+
+And that's it, you have to do anything else on the controller to create a **CRUD** maintenance for the country model.
+
+`resource_for` will **handle all the restful** actions for you and it will give you the next's helper_methods for your convenience:
+
+**`resources`:** this will have a collection of `Country`, objects so you can use on the `index` actions or any other collection route actions of your controller
+
+**`resource`:** this will have a  `Country`, object so you can use on the member route actions like  `new, create, edit, update, show, destroy` 
+
+**`resources_search`:**  this is a **[ransack](https://github.com/activerecord-hackery/ransack)** object to you in the `search_form_for` helper
+
+**`resource_saved?`:** this is a helper to user after create or update a record to know if it was saved.
+
+
+## OPTIONS AND FLEXIBILITY
+
+
+
+`resource_for` by default expects the `params` key for update or create the object to be `resource` if you use `form_for` or `simple_form` you need to add the `as: :resource` option
+
+
+```
+= simple_form_for [:admin, resource], as: :resource do |f|
+  = f.input :code
+  = f.input :name
+  = f.input :active
+  = f.submit "SAVE"
+```
+
+
+
+#### **RESOURCE PARAMS -  `params_resource`** 
+
+This options allows you to change the default params key used for create or update the record. So you have to add the `as: :resource` to the `simple_form_for`
+
+```
+class Admin::CountriesController < ApplicationController
+  resource_for :"Country", 
+    params_resource: :country 
+end
+```
+
+Or you can use the  `lambda` syntax.
+
+```
+class Admin::CountriesController < ApplicationController
+  resource_for :"Country", 
+    params_resource: lambda{ |params|   params[:country] } 
+end
+```
+
+#### **RESOURCE ALIAS - `resource_method_name` - `resources_method_name`**
+
+This options allows you to alias the `resource` method in case you don't like the name.  if you don't specify a `resources_method_name` it will name the alias to `resource_method_name` **pluralized**.
+
+```
+class Admin::CountriesController < ApplicationController
+  resource_for :"Country", 
+    params_resource: :country,
+    resource_method_name: :country 
+end
+```
+**NOTE:** making a change in `resource_method_name` and `resources_method_name` options requires a **server restart**. 
+
+Now in your view you can use `country` instead of `resource`
+
+```
+= simple_form_for [:admin, country] do |f|
+  = f.input :code
+  = f.input :name
+  = f.input :active
+  = f.submit "SAVE"
+```
+
+
+#### **PAGINATION - `pagination`**
+
+This option enable pagination in case that you use any of the most popular pagination gems ([kaminari](https://github.com/amatsuda/kaminari) or [will_paginate](https://github.com/mislav/will_paginate)).
+
+```
+class Admin::CountriesController < ApplicationController
+  resource_for :"Country", 
+    pagination: true, 
+    params_resource: :country,
+    resource_method_name: :country 
+end
+```
+
+Or you can use the  `lambda` syntax.
+
+```
+class Admin::CountriesController < ApplicationController
+  resource_for :"Country", 
+    pagination: lambda{ |params, controller| params[:disable_pagination].blank? }, 
+    params_resource: :country,
+    resource_method_name: :country 
+end
+```
+
+#### **DEFAULT SCOPES - `resource_scope`- `resources_scope`**
+
+This options are to set a default `scope` for the `resources`, and `resource` objects.
+
+
+```
+class Admin::CountriesController < ApplicationController
+  resource_for :"Country", 
+    resources_scope: :active,
+    pagination: true, 
+    params_resource: :country,
+    resource_method_name: :country 
+end
+```
+**Note:** this will execute the scope `active` and get you only the countries that are currently actives.
+
+You can use the  `lambda` syntax for a **more complex scope**.
+
+```
+class Admin::CountriesController < ApplicationController
+  resource_for :"Country", 
+    resources_scope: lambda{ |scope, params, controller|
+      scope.by_active_state(params[:active_state]).includes(:cities)
+    },
+    pagination: true, 
+    params_resource: :country,
+    resource_method_name: :country 
+end
+```
+
+
+#### **SEARCH - `search`- `search_options`**
+
+The `search` option enable [ransack](https://github.com/activerecord-hackery/ransack) in case that you have installed it. And the `search_options` allows you to pass a hash of parameters to the result method of ransack like **`distinct: true`**
+
+
+```
+class Admin::CountriesController < ApplicationController
+  resource_for :"Country",
+    search: true, 
+    search_options: {distinct: true}, 
+    resources_scope: :active,
+    pagination: true, 
+    params_resource: :country,
+    resource_method_name: :country 
+end
+```
+**NOTE:** For the use of the** `search_form_for`** you have the `resources_search` helper that is a racksack object or in this case `countries_search` because we used the resource alias `resource_method_name`
+
+```
+= search_form_for [:admin, countries_search] do |f|
+  = f.label :name_cont 
+  = f.search_field :name_cont 
+  = f.submit 
+```
+
+#### **GLOBAL CONFIGURATION **
+
+You can change the default parameters of any configuration by change the options in the `config/initializers/resources.rb` that was generated by running `rails g resources:install` 
+
+```
+Resources.config do |config|
+  config.params_search = :q # ransack search parameter. Default params[:q]
+  config.params_resource = :resource # resource parameter to be saved.  
+end
+```
+
+
+----------
+
+
+## **Copyright**
+
+Copyright (c) 2015 Emilio Forrer. See LICENSE.txt for further details.
+
+

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Resources'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/generators/rails/USAGE

@@ -0,0 +1,25 @@
+Description:
+
+  Generate Resource Controller
+
+Example:
+
+    rails g resource_controller country
+
+    This will create:
+        create    app/controllers/countries_controller.rb
+        create    app/views/countries
+        create    app/views/countries/index.html.erb
+        create    app/views/countries/edit.html.erb
+        create    app/views/countries/show.html.erb
+        create    app/views/countries/new.html.erb
+        create    app/views/countries/_form.html.erb
+        create    test/functional/countries_controller_test.rb
+        create    app/helpers/countries_helper.rb
+        create    test/unit/helpers/countries_helper_test.rb
+
+    and inside of the controller it will call resource_for
+
+    class CountriesController < ApplicationController
+      resource_for :"Country"
+    end

data/lib/generators/rails/resource_controller_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators/rails/scaffold_controller/scaffold_controller_generator'
+
+module Rails
+  module Generators
+    class ResourceControllerGenerator < Rails::Generators::ScaffoldControllerGenerator
+      def self.source_root
+        @source_root ||= File.expand_path('../templates', __FILE__)
+      end
+    end
+  end
+end
+
+

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

@@ -0,0 +1,9 @@
+<% if namespaced? -%>
+require_dependency "<%= namespaced_file_path %>/application_controller"
+
+<% end -%>
+<% module_namespacing do -%>
+class <%= controller_class_name %>Controller < ApplicationController
+  resource_for :"<%= controller_class_name.to_s.singularize.demodulize %>"
+end
+<% end -%>

data/lib/generators/resources/install/USAGE

@@ -0,0 +1,10 @@
+Description:
+
+  Configuration Initializer
+
+Example:
+
+    rails g resources:install
+
+    This will create:
+        config/initializers/resources.rb

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

@@ -0,0 +1,8 @@
+class Resources::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  def generate_install
+    copy_file "config/initializers/resources.rb", "config/initializers/resources.rb"
+  end
+
+  
+end

data/lib/generators/resources/install/templates/config/initializers/resources.rb

@@ -0,0 +1,30 @@
+# GLobal Configuration
+Resources.config do |config|
+
+  config.rest_actions = true # Enable restful actions (index,new, create, etc)
+  config.search = false # Enable ransack search object (resources_search) 
+  config.search_options =  {distinct: false} # ransack result options. Default {distinct: false}
+
+  # Setting Params (params_search, params_resource, etc)
+  # You can specify a params key like :q, that will be params[:q]
+  # Or you can set a lambda like lambda{ |params|   params[:q] }
+  config.params_search = :q # ransack search parameter. Default params[:q]
+  config.params_resource = :resource # resource parameter to be saved. Default params[:resource]
+  config.params_page = :page # Pagination parameter. Default params[:page]
+
+
+  config.pagination =  false # Enables pagination (kaminari or will_paginate)
+
+  # Setting a default scope for the collection and resource objects
+  # You can specify an scope name to be executed like :active
+  # Or if you have something more complex or need to pass a parameter to the scope, you can use a lambda like lambda{ |scope, params, controller|   scope.by_activation(params[:active]).includes(:states) }
+  config.resource_scope = nil # default scope for resource object
+  config.resources_scope =  nil # default scope for resources collection
+
+  # Setting alias method of resource, if you change the value to, for example :country you will gain this extra helper methods:
+  # countries for the collection object
+  # country for the resource object 
+  # country_saved? to know if the resource was saved
+  config.resource_method_name =  :resource # alias method of resource
+  config.resources_method_name =  nil # alias method of resources, if you dont specify one it takes "resource_method_name.to_s.pluralize" 
+end

data/lib/loader.rb

@@ -0,0 +1,6 @@
+require "resources/actions"
+require "resources/rest_actions"
+require "resources/configuration"
+require "resources/controller"
+require "resources/routes"
+require "resources/manager"

data/lib/resources.rb

@@ -0,0 +1,5 @@
+require "loader"
+module Resources
+  
+end
+ActionController::Base.send(:include, Resources::Controller)

data/lib/resources/actions.rb

@@ -0,0 +1,46 @@
+module Resources
+  module Actions
+    extend ActiveSupport::Concern
+          
+      included do
+        helper_method :resources, :resource, :resources_search
+
+        if self.resource_configuration.resource_method_name
+          self.class_eval <<-RUBY
+            
+            alias_method :#{self.resource_configuration.resources_method_name.to_s}, :resources
+            alias_method :#{self.resource_configuration.resource_method_name.to_s}, :resource
+            alias_method :#{self.resource_configuration.resources_method_name.to_s}_search, :resources_search
+            helper_method :#{self.resource_configuration.resources_method_name.to_s}, :#{self.resource_configuration.resource_method_name.to_s}, :#{self.resource_configuration.resources_method_name.to_s}_search
+          RUBY
+        end
+      end
+
+      def resources_search
+        @resources_search ||= resource_manager.resources_search
+      end
+
+      def resources
+        @resources ||= resource_manager.resources
+      end
+
+      def resource
+        @resource ||= resource_manager.resource
+      end 
+
+      
+
+      protected
+
+      def resource_manager
+        @resource_manager ||= Resources::Manager.new(self, request)
+      end
+
+      
+
+
+      def member_route?
+        params[:id].present?
+      end
+  end
+end