zobi 4.0.0.rc2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69518a2db256e0b503887391e17de15b8007cb16
+  data.tar.gz: b13497e78105e33a61f8d083736ac2e023633a91
+SHA512:
+  metadata.gz: f99d0a53a9257f453ef2cfc1c3ee6a3f0b288710ffdae88f53352392b1ad532b9108dce9e929d2183f4277fbeb889165bdaf73931a6b2797e95d7dbf1d730d7c
+  data.tar.gz: 9fab74b46acb53cad0cb57d861b9e50cd327435e8036c42342d17530ffed9ff3630b246341d2c083183deef9504fcbc85f8c507aab81a26aaf530a96fdad0519

data/README.md

@@ -0,0 +1,170 @@
+Zobi
+====
+
+Zobi helps you to orchestrate your controller behaviors using the following gems :
+
+- [**devise**](https://github.com/plataformatec/devise)
+- [**inherited_resources**](https://github.com/josevalim/inherited_resources)
+- [**has_scope**](https://github.com/plataformatec/has_scope)
+- [**kaminari**](https://github.com/amatsuda/kaminari)
+- [**pundit**](https://github.com/elabs/pundit)
+- [**draper**](https://github.com/drapergem/draper)
+
+How to use it?
+--------------
+
+Add it in your `Gemfile` and run `bundle install`:
+
+```ruby
+gem 'zobi', '~> 4.0.0.rc2'
+```
+
+Next, include Zobi module in your controller and set modules you want to
+include :
+
+```ruby
+extend Zobi
+behaviors :inherited, :scoped, :included, :paginated, :controlled_access, :decorated
+```
+
+Available modules
+-----------------
+
+### Inherited
+
+This module uses
+[inherited_resources](https://github.com/josevalim/inherited_resources) gem.
+
+This module deals with String Parameters using Parameters classes.
+
+A Parameters inherits from Zobi::ParametersSanitizer, and should define the list
+of parameters and nested parameters to accept.
+
+If your controller is namespaced, you should define the `resource_type` method to
+override its generic behavior.
+
+If your model is namespaced, you should define the defaults resource_class for
+Inherited Resource, ie : `defaults resource_class: ::User::Address`
+
+Here is an example :
+
+``` ruby
+module User
+  class AddressParameters < Zobi::ParametersSanitizer
+
+    # Optional, usefull for a namespaced controller, User::AddressesController
+    # here.
+    def resource_type
+      :user_address
+    end
+
+    protected
+
+    def fields
+      [
+        :id,
+        :street,
+        :zip_code,
+        nested_attributes: [:id, :foo, :bar]
+      ]
+    end
+  end
+end
+```
+
+By default, Parameters class are discovered using the controller namespace.
+Given a `User::AddressesController`, Zobi will search for
+`User::AddressParameters` class.
+
+If you don't want to use Parameters class, you can define the `permitted_params`
+in your controller and perform custom filtering.
+
+### Scoped
+
+This module uses [has_scope](https://github.com/plataformatec/has_scope) gem.
+
+
+### Included
+
+This module only works with ActiveRecord because it uses the
+[Eager Loading Associations of Active Record](http://guides.rubyonrails.org/active_record_querying.html#eager-loading-associations).
+
+
+### Paginated
+
+This module uses [kaminari](https://github.com/amatsuda/kaminari) gem.
+
+
+### Controlled Access
+
+This module uses [pundit](https://github.com/elabs/pundit) and
+[devise](https://github.com/plataformatec/devise) gems.
+
+
+### Decorated
+
+This module uses [draper](https://github.com/drapergem/draper) gem and has a
+dependency on Inherited modules for now.
+
+By default, Zobi will try to discover the decorator class to use using the
+current namespece.
+
+For example, given a controller named Admin::User::AddressesController, Zobi
+will try to find the appropriate decorator class in this order :
+
+Collection :
+
+``` ruby
+Admin::User::AddressesDecorator
+Admin::AddressesDecorator
+AdressesDecorator
+Admin::User::CollectionDecorator
+Admin::CollectionDecorator
+CollectionDecorator
+```
+
+Resource :
+
+``` ruby
+Admin::User::AddressDecorator
+Admin::AddressDecorator
+AdressDecorator
+Admin::User::ResourceDecorator
+Admin::ResourceDecorator
+ResourceDecorator
+```
+
+If this is not the way you organize your decorators, you can override this
+behavior by defining a method called `collection_decorator_class` or
+`decorator_class` which returns the decorator class to use.
+
+
+# Developing
+
+Launch test suite :
+
+``` console
+cd spec/dummy
+bundle exec rake db:test:prepare
+cd ../..
+bundle exec rspec
+```
+
+Launch the dummy app :
+
+``` console
+cd spec/dummy
+bundle exec rake db:migrate
+bundle exec rails s
+```
+
+# Versioning
+
+We decided to follow rails versions to simplify update of Zobi when you want to
+upgrade rails.
+
+# Credits
+
+Copyright (c) 2013 af83
+
+Released under the MIT license

data/app/decorators/zobi/collection_decorator.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+module Zobi
+  class CollectionDecorator < Draper::CollectionDecorator
+    include Draper::AutomaticDelegation
+  end
+end

data/app/decorators/zobi/resource_decorator.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+module Zobi
+  class ResourceDecorator < Draper::Decorator
+    delegate_all
+  end
+end

data/lib/zobi.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+Dir["#{File.dirname(__FILE__)}/zobi/**/*.rb"].each { |f| require f }
+
+module Zobi
+  BEHAVIORS = [:inherited, :scoped, :included, :paginated, :controlled_access, :decorated].freeze
+
+  def self.extended base
+    base.helper_method :collection, :resource
+  end
+
+  def behaviors *behaviors
+    (BEHAVIORS & behaviors).each do |behavior|
+      send(:include, behavior_module(behavior))
+    end
+    send(:include, ::Zobi::InstanceMethods)
+  end
+
+  def behavior_module name
+    "Zobi::#{name.to_s.camelize}".constantize
+  end
+
+  def behavior_included? name
+    ancestors.include?(behavior_module(name))
+  end
+
+  module InstanceMethods
+
+    def zobi_resource_class
+      return resource_class if self.class.behavior_included?(:inherited)
+      self.class.name.demodulize.gsub('Controller', '').singularize.constantize
+    end
+
+    def collection
+      return @collection if @collection
+      c = zobi_resource_class
+      BEHAVIORS.each do |behavior|
+        next unless self.class.behavior_included?(behavior)
+        c = send :"#{behavior}_collection", c
+      end
+      @collection = (c.is_a?(Class) ? c.all : c)
+    end
+
+  end
+end

data/lib/zobi/controlled_access.rb

@@ -0,0 +1,77 @@
+# encoding: utf-8
+
+module Zobi
+  # This module help to manage control access on your collection using pundit.
+  #
+  module ControlledAccess
+
+    def self.included base
+      base.send :include, Pundit
+      base.class_eval do
+        before_filter :authorize_resource
+
+        def policy_scope scope
+          Pundit.policy_scope!(controlled_access_user, scope)
+        end
+
+        def policy record
+          Pundit.policy!(controlled_access_user, record)
+        end
+      end
+    end
+
+    protected
+
+    # Authorize resource, see Policies.
+    def authorize_resource
+      case action_name
+      when build_resources_authorized
+        authorize controlled_access_build_resource
+      when resources_authorized
+        authorize controlled_access_resource
+      else
+        authorize zobi_resource_class
+      end
+    end
+
+    def controlled_access_user
+      if self.class.to_s.split('::').first == 'Admin'
+        begin
+          current_administrator
+        rescue NameError
+          raise "You need to define the current_administrator method.".inspect
+        end
+      else
+        begin
+          current_user
+        rescue NameError
+          raise "You need to define the current_user method.".inspect
+        end
+      end
+    end
+
+    private
+
+    def controlled_access_collection c
+      policy_scope c
+    end
+
+    def build_resources_authorized
+      /new|create/
+    end
+
+    def resources_authorized
+      /edit|update|show|destroy/
+    end
+
+    def controlled_access_build_resource
+      return build_resource if respond_to?(:build_resource)
+      zobi_resource_class.new params[zobi_resource_class.to_s.to_sym]
+    end
+
+    def controlled_access_resource
+      return resource if respond_to?(:resource)
+      zobi_resource_class.find(params[:id])
+    end
+  end
+end

data/lib/zobi/decorated.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+module Zobi
+  # This module decorate your collection and resource
+  # NB: dependencie on Inherited module
+  #
+  module Decorated
+
+    def resource
+      @resource ||= decorator_class.decorate super
+    end
+
+    protected
+
+    def collection_decorator_class
+      Zobi::Discover.new(self.class, :decorated, :collection).resolve
+    end
+
+    def decorator_class
+      Zobi::Discover.new(self.class, :decorated, :resource).resolve
+    end
+
+    private
+
+    def decorated_collection c
+      collection_decorator_class.decorate(
+        (c.is_a?(Class) ? c.all : c),
+        with: decorator_class
+      )
+    end
+  end
+end

data/lib/zobi/discover.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+
+module Zobi
+  Discover = Struct.new(:klass, :behavior, :type) do
+    CONFIG = {
+      decorated: {
+        suffix: 'Decorator',
+        resource: 'ResourceDecorator',
+        collection: 'CollectionDecorator'
+      }
+    }.freeze
+
+    def resolve
+      discovery.each do |klass|
+        begin
+          return klass.constantize
+        rescue NameError
+          next
+        end
+      end
+      "Zobi::#{fallback}".constantize
+    end
+
+    private
+
+    def namespaces
+      last = ""
+      ns = klass.to_s.split('::')
+      ns.pop
+      ns.map{|i| last += "::#{i}"}.reverse.push '::'
+    end
+
+    def resource_class
+      collection_class.singularize
+    end
+
+    def collection_class
+      klass.to_s.demodulize.gsub('Controller', '')
+    end
+
+    def base_class
+      type == :resource ? resource_class : collection_class
+    end
+
+    def discovery
+      discovery = []
+      discovery << self.class.classes_for_namespaces(
+        namespaces, "#{base_class}#{suffix}"
+      )
+      discovery << self.class.classes_for_namespaces(namespaces, fallback)
+      discovery.flatten
+    end
+
+    def fallback
+      CONFIG[behavior][type]
+    end
+
+    def suffix
+      CONFIG[behavior][:suffix]
+    end
+
+    class << self
+      def classes_for_namespaces namespaces, base_name
+        namespaces.map{|ns|
+          "#{ns == '::' ? ns : "#{ns}::"}#{base_name}"
+        }
+      end
+    end
+  end
+end

data/lib/zobi/engine.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+module Zobi
+  class Engine < Rails::Engine
+  end
+end

data/lib/zobi/included.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module Zobi
+  module Included
+
+    protected
+
+    def includes
+      nil
+    end
+
+    private
+
+    def included_collection c
+      c = c.includes(*includes) if includes.present?
+      c
+    end
+
+  end
+end

data/lib/zobi/inherited.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+module Zobi
+  # This module add some helpers to controllers.
+  #
+  #   * inherit_resources
+  #   * params filtering
+  #
+  module Inherited
+    def self.included(klass)
+      klass.inherit_resources
+      klass.send('include', Inherited::Hidden)
+    end
+
+    private
+
+    def inherited_collection c
+      end_of_association_chain
+    end
+
+    module Hidden
+      protected
+
+      # This method can be overwritted in controllers
+      def permitted_params
+        @permitted_params ||= parameters_class.new(self, params).params
+      end
+
+      private
+
+      def parameters_class
+        klass = "#{self.class.to_s.sub('Controller', '').singularize}Parameters"
+        klass.constantize
+      rescue NameError
+        raise <<EOT
+You need to define the class #{klass} or overwrite the permitted_params method in your controller.
+EOT
+      end
+    end
+
+  end
+end

data/lib/zobi/paginated.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+module Zobi
+  # This module helps you to paginate your collection using kaminari
+  #
+  module Paginated
+
+    def self.included base
+      base.send :responders, 'zobi/responders/pagination'
+    end
+
+    protected
+
+    def paginate_per
+      params[:per]
+    end
+
+    private
+
+    def paginated_collection c
+      c.page(params[:page]).per(paginate_per)
+    end
+  end
+end

data/lib/zobi/parameters_sanitizer.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+module Zobi
+  # This class responsability is to filter parameters before sending it to the
+  # model.
+  #
+  # This class is meant to be inherited.
+  #
+  # Most of the time, two methods will be overriden: `fields` and
+  # `translated_fields`.
+  #
+  # If you need complex logic based on context of execution (user rights and so
+  # on...), you have access to the controller through the `context` attr.
+  # Meaning, `context.current_user` is possible. And then, you can implement
+  # all the `if` possible in the world.
+  #
+  class ParametersSanitizer
+    attr_reader :context, :canonical_params
+    private :context, :canonical_params
+
+    # @param [ApplicationController] context
+    # @param [ActionController::Parameters] canonical_params
+    #
+    # @return [Sanitizer]
+    #
+    def initialize(context, canonical_params)
+      @context, @canonical_params = context, canonical_params
+    end
+
+    # The only public method. Return sanitized parameters.
+    #
+    # @return [ActionController::Parameters]
+    #
+    def params
+      canonical_params.permit resource_type => permitted_fields
+    end
+
+    protected
+
+    # @return [Array] array of fields
+    #
+    def fields
+      []
+    end
+
+    # @return [Array] array of translated fields
+    #
+    def translated_fields
+      []
+    end
+
+    # @return [Array] array of locales
+    #
+    def locales
+      I18n.available_locales
+    end
+
+    # Computes all the fields
+    #
+    # @return [Array] Complete list of fields
+    #
+    def permitted_fields
+      fields + locales.map {|l| translated_fields.map {|f| "#{f}_#{l}" }}
+    end
+
+    # @return [Symbol] The resource name to be required
+    #
+    def resource_type
+      self.class.to_s.demodulize.gsub('Parameters', '').underscore.to_sym
+    end
+  end
+end

data/lib/zobi/responders/pagination_responder.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module Zobi
+  module Responders
+    module PaginationResponder
+
+      def respond(*)
+        if paginated?
+          controller.headers['X-Total-Pages']   = resource.total_pages.to_s
+          controller.headers['X-Current-Page']  = resource.current_page.to_s
+          controller.headers['X-Limit-Value']   = resource.limit_value.to_s
+        end
+        super
+      end
+
+      private
+
+      def paginated?
+        resource.respond_to?(:total_pages) &&
+          resource.respond_to?(:current_page) &&
+          resource.respond_to?(:limit_value)
+      end
+    end
+  end
+end

data/lib/zobi/scoped.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+module Zobi
+  # This module helps you to filter your collection using has_scope
+  #
+  module Scoped
+    def self.included(klass)
+      klass.helper_method :filters_list
+      klass.before_filter :default_order
+    end
+
+    protected
+
+    def filters_list
+      scopes_configuration.keys
+    end
+
+    private
+
+    def scoped_collection c
+      apply_scopes c
+    end
+
+    def default_order
+      return unless params[:by_order]
+      {order: 'created_at', direction: 'desc'}.each do |k, v|
+        next if params[:by_order][k].present?
+        params[:by_order][k] = v
+      end
+    end
+  end
+end

data/lib/zobi/version.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+module Zobi
+  VERSION = "4.0.0.rc2"
+end

metadata

@@ -0,0 +1,283 @@
+--- !ruby/object:Gem::Specification
+name: zobi
+version: !ruby/object:Gem::Version
+  version: 4.0.0.rc2
+platform: ruby
+authors:
+- klacointe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: responders
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: inherited_resources
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: has_scope
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0.rc
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0.rc
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: pundit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: draper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Keep your rails controllers DRY while using devise, inherited_resources,
+  has_scope, kaminari, pundit and draper
+email: kevinlacointe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- app/decorators/zobi/collection_decorator.rb
+- app/decorators/zobi/resource_decorator.rb
+- lib/zobi.rb
+- lib/zobi/controlled_access.rb
+- lib/zobi/decorated.rb
+- lib/zobi/discover.rb
+- lib/zobi/engine.rb
+- lib/zobi/included.rb
+- lib/zobi/inherited.rb
+- lib/zobi/paginated.rb
+- lib/zobi/parameters_sanitizer.rb
+- lib/zobi/responders/pagination_responder.rb
+- lib/zobi/scoped.rb
+- lib/zobi/version.rb
+homepage: https://github.com/af83/zobi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Keep your rails controllers DRY.
+test_files: []