power_resource 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e0f9fc6dee728f9630996271a5beed85771e9cd
-  data.tar.gz: d702eaa22dacbb157e5e1308c866a95eec5546fd
+  metadata.gz: 569c654414000d901c35f50fbd4b72bcff29baed
+  data.tar.gz: c1a14b6341b5cbb18c8f0e60cd4aec4d6c84137f
 SHA512:
-  metadata.gz: fcf0b8d8ec2a666215b8cdc04bf719ffc41bb9e3b4fe383c70a9572c7cc7ed8a76738d21e5463f7bfc785ed3312afbc799cf46ff400c2b0fe977480a51b5835d
-  data.tar.gz: 2644d8ca0872750688a129c21f2666f29fd07cdcc1ad2c4eac867e4bb2785befab282d2e7b54eb1931374d664c46c7d82de21a5c576e7fe46aba88b2edb59bbc
+  metadata.gz: f1b9342255ab6b0e122f6928d25e64b20ad2f016eb04d2f5189d5bf029d94377a46b96503140fb228b55f9601ec5c6802756a0ada36635d8e569f118d1b1c8f1
+  data.tar.gz: bab58253ced3a12c58d56318cfcdf4ac1a4a5f38203cf5be8725219ffb54b8422738f8d7b352b51d8b2ac3fa2bfe4162568de5139f8d1a28e0393bfa975323ea

data/Gemfile

@@ -2,5 +2,5 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'inherited_resources', github: 'josevalim/inherited_resources'
-gem 'formtastic'
+gem 'jquery-rails' # Required for delete links
+

data/README.md

@@ -1,13 +1,12 @@
 # PowerResource
 
-Power up your RESTful resources!
-
-ALPHA STAGE, DO NOT USE IN PRODUCTION!
+Power up RESTful resources!
 
 ## Requirements
 
-* Ruby 2.0.0 or greater
-* Rails 4.0.0 or greater
+* Ruby 2.0 or greater
+* Rails 4.0 or greater
+* Active Record 4.0 or greater
 
 ## Installation
 
@@ -25,22 +24,90 @@ Or install it yourself as:
 
 ## Usage
 
+### Basic Usage
+
 Inherit your resource controllers from PowerResource::BaseController:
 
-    class ProductsController < PowerResource::BaseController
+    class PostsController < PowerResource::BaseController
+    end
+
+### Strong Parameters
+
+Permit **only** title and content (recommended way):
+
+    class PostsController < PowerResource::BaseController
+      def permit_attributes
+        %w(title content)
+      end
+    end
+
+Permit **all** attributes:
+
+    class PostsController < PowerResource::BaseController
+      def permit_attributes
+        resource_attributes
+      end
+    end
+
+Permit all attributes **except** id:
+
+    class PostsController < PowerResource::BaseController
+      def permit_attributes
+        resource_attributes - %w(id)
+      end
+    end
+    
+Permit all **human-readable attributes** (all except id, created\_at and
+updated\_at):
+
+    class PostsController < PowerResource::BaseController
+      def permit_attributes
+        resource_human_attributes
+      end
+    end
+
+Permit all **human-readable attributes, except** title and content:
+
+    class PostsController < PowerResource::BaseController
+      def permit_attributes
+        resource_human_attributes - %w(title content)
+      end
+    end
+
+Setting default behaviour can be done in ApplicationController:
+
+    class ApplicationController < ActionController::Base
+      def permit_attributes
+        resource_human_attributes
+      end
+    end
+
+Also, you can use [Inherited Resources
+way](https://github.com/josevalim/inherited_resources#strong-parameters) way:
+
+    class PostsController < PowerResource::BaseController
+      def permitted_params
+        params.permit(post: %w(title content))
+      end
     end
 
-## Helpers
+### Helpers
 
-Besides all [helpers from Inherited Resources gem](https://github.com/josevalim/inherited_resources#url-helpers), next helper methods are available:
+Besides all [helpers from Inherited Resources
+gem](https://github.com/josevalim/inherited_resources#url-helpers), next helper
+methods are available:
 
     resource_form_path   #=> /products     when creating a new resource
                          #=> /products/1   when resource already exists
 
 ## Support
 
-If you have any questions or issues with PowerResource, or if you like to report a bug, please create an [issue on GitHub](https://github.com/jarijokinen/power_resource/issues).
+If you have any questions or issues with PowerResource, or if you like to
+report a bug, please create an [issue on
+GitHub](https://github.com/jarijokinen/power_resource/issues).
 
 ## License
 
-MIT License. Copyright (c) 2013 [Jari Jokinen](http://jarijokinen.com). See [LICENSE](https://github.com/jarijokinen/power_resource/blob/master/LICENSE.txt) for further details.
+MIT License. Copyright (c) 2013 [Jari Jokinen](http://jarijokinen.com). See
+[LICENSE](https://github.com/jarijokinen/power_resource/blob/master/LICENSE.txt)
+for further details.

data/app/controllers/power_resource/base_controller.rb

@@ -3,6 +3,8 @@ module PowerResource
     inherit_resources
     defaults route_prefix: ''
 
+    include PowerResource::BaseHelper
+
     def create
       create! { collection_url }
     end
@@ -13,18 +15,28 @@ module PowerResource
 
     protected
 
-    def resource_name
-      controller_name.tableize.singularize.to_sym
+    def permit_attributes
+      # Override this method in your controller:
+      #
+      #   class PostsController < PowerResource::BaseController
+      #     def permit_attributes
+      #       %w(title content)
+      #     end
+      #   end
+      #
+      # Or add default behaviour in your ApplicationController:
+      #
+      #   class ApplicationController < ActionController::Base
+      #     def permit_attributes
+      #       resource_human_attributes
+      #     end
+      #   end
     end
 
     def permitted_params
       params.permit(
-        resource_name => resource_class.attribute_names - denied_params
+        resource_name => permit_attributes
       )
     end
-
-    def denied_params
-      %w(id created_at updated_at)
-    end
   end
 end

data/app/helpers/power_resource/action_helper.rb

@@ -0,0 +1,147 @@
+module PowerResource
+  module ActionHelper
+    # Returns humanized name for an action
+    #
+    # Customization using I18n API:
+    #
+    #   power_resource:
+    #     actions:
+    #       new: 'New %{resource_name}'
+    #       edit: 'Edit %{resource_name}'
+    #       index: '%{collection_name}'
+    #
+    # Variables available in I18n:
+    #
+    #   resource_name            # => Post
+    #   downcased_resource_name  # => post
+    #   collection_name          # => Posts
+    #
+    # Examples:
+    #
+    #   resource_action_human_name(:new)
+    #     # => New Post
+    #   resource_action_human_name(:edit)
+    #     # => Edit Post
+    #   resource_action_human_name(:duplicate)
+    #     # => Duplicate Post
+    #   resource_action_human_name(:index)
+    #     # => Posts
+    #
+    def resource_action_human_name(action_name, options = {})
+      I18n.t("power_resource.resource_actions.#{action_name.to_s}",
+        { 
+          resource_name: resource_human_name,
+          downcased_resource_name: resource_human_name.downcase,
+          collection_name: collection_human_name,
+          default: (action_name == :index ? collection_human_name :
+                    "#{action_name.to_s.humanize} #{resource_human_name}")
+        }.merge(options))
+    end
+    
+    # Returns a title for a current resource based on an action
+    #
+    # Customization using I18n API:
+    #
+    #   power_resource:
+    #     titles:
+    #       post:
+    #         new: 'New %{resource_name}'
+    #         edit: 'Edit %{resource_name}'
+    #         delete: 'Delete %{downcased_resource_name}'
+    #         index: '%{collection_name}'
+    #
+    # Variables available in I18n:
+    #
+    #   resource_name            # => Post
+    #   downcased_resource_name  # => post
+    #   collection_name          # => Posts
+    #
+    # Examples:
+    #
+    #   resource_action_title(:new)
+    #     # => New Post
+    #   resource_action_title(:edit)
+    #     # => Edit Post
+    #   resource_action_title(:duplicate)
+    #     # => Duplicate Post
+    #   resource_action_title(:index)
+    #     # => Posts
+    #
+    def resource_action_title(action_name, options = {})
+      I18n.t("power_resource.titles.#{resource_name}.#{action_name.to_s}", 
+        { 
+          resource_name: resource_human_name,
+          downcased_resource_name: resource_human_name.downcase,
+          collection_name: collection_human_name,
+          default: resource_action_human_name(action_name, options)
+        }.merge(options))
+    end
+
+    # Returns a link for a current resource based on an action
+    #
+    # Customization using I18n API:
+    #
+    #   power_resource:
+    #     links:
+    #       post:
+    #         new: 'New %{resource_name}'
+    #         edit: 'Edit'
+    #         index: '%{collection_name}'
+    #
+    # Variables available in I18n:
+    #
+    #   resource_name            # => Post
+    #   downcased_resource_name  # => post
+    #   collection_name          # => Posts
+    #
+    # Examples:
+    #
+    #   resource_link_to(:new)
+    #     # => <a href="/posts/new">New Post</a>
+    #   resource_link_to(:edit, resource)
+    #     # => <a href="/posts/1/edit">Edit</a>
+    #   resource_link_to(:index)
+    #     # => <a href="/posts/">Posts</a>
+    #
+    def resource_link_to(action_name, resource_instance = nil)
+      if resource_instance
+        human_name = resource_human_name_for(resource_instance.class.name)
+      end
+
+      case action_name
+      when :show, :edit, :delete
+        default_text = I18n.t("power_resource.actions.#{action_name.to_s}", 
+          default: action_name.to_s.humanize)
+      else
+        default_text = resource_action_human_name(action_name)
+      end
+
+      text = I18n.t("power_resource.links.#{resource_name}.#{action_name.to_s}",
+        {
+          resource_name: human_name || resource_human_name,
+          downcased_resource_name: human_name ? human_name.downcase : 
+            resource_human_name.downcase,
+          collection_name: collection_human_name,
+          default: default_text
+        })
+
+      case action_name
+      when :index
+        link_to(text, collection_path)
+      when :show
+        link_to(text, resource_path(resource_instance || resource))
+      when :new
+        link_to(text, new_resource_path)
+      when :edit
+        link_to(text, edit_resource_path(resource_instance || resource), 
+          class: collection_table_button_classes)
+      when :delete
+        link_to(text, resource_path(resource_instance || resource), 
+          class: collection_table_button_classes,
+          method: :delete, data: { 
+            confirm: I18n.t('power_resource.confirmations.delete', 
+                            default: 'Are you sure?') })
+      end
+    end
+  end
+end

data/app/helpers/power_resource/base_helper.rb

@@ -1,58 +1,62 @@
 module PowerResource
   module BaseHelper
-    # Returns humanized and localized name for a current resource model
+    # Returns a name for a current resource
+    def resource_name
+      resource_class.to_s.tableize.singularize
+    end
+    
+    # Returns humanized and localized name for a current resource
     def resource_human_name
       resource_class.model_name.human
     end
-
-    # Returns humanized and localized name for a specified resource class
-    def resource_human_name_for(resource_class_name)
-      eval("#{resource_class_name.to_s.classify}.model_name.human")
-    end
-
-    # Returns an unique title for a resource
-    def resource_title
-      "#{resource_human_name} #{resource.id}"
+    
+    # Returns humanized and localized name for a specific resource
+    def resource_human_name_for(resource_class_name, count = 1)
+      class_name = resource_class_name.to_s.classify
+      eval(class_name).model_name.human(count: count)
     end
 
-    # Returns a title for a collection
-    def collection_title
-      I18n.t("activemodel.models.#{controller_name.singularize}.other",
-        default: controller_name.humanize)
+    # Returns an unique title for a current resource
+    def resource_title(options = {})
+      I18n.t("power_resource.titles.#{resource_name}.resource",
+        { default: "#{resource_human_name} #{resource.id}" }.merge(options) )
     end
 
     # Returns all attributes for a resource
     def resource_attributes
       resource_class.attribute_names
     end
-
+    
     # Returns attributes that should be invisible for end-users
-    def non_human_attributes
-      %w(id updated_at created_at)
+    def resource_non_human_attributes
+      %w(id created_at updated_at)
     end
-
+    
     # Returns attributes for a resource without non-human attributes
     def resource_human_attributes
-      human_attributes = resource_attributes - non_human_attributes
-      if respond_to?("parent?")
+      human_attributes = resource_attributes - resource_non_human_attributes
+
+      # If resource has a belongs_to relationship, remove reference attribute
+      if respond_to?('parent?')
         parent_attribute = "#{parent.class.name.underscore}_id"
-        human_attributes = human_attributes - ["#{parent_attribute}"]
+        human_attributes = human_attributes - [parent_attribute]
       end
+
       human_attributes
     end
 
     # Returns humanized and localized attribute name
-    def attribute_human_name(attribute_name)
+    def resource_attribute_human_name_for(attribute_name)
       attribute_name = attribute_name.to_s
-      I18n.t("activerecord.attributes.#{controller_name.singularize}.#{attribute_name}",
+      I18n.t("activerecord.attributes.#{resource_name}.#{attribute_name}",
         default: attribute_name.humanize)
     end
 
-    # Returns truncated attribute value
-    def attribute_value(resource, attribute_name, truncation = 50)
+    # Returns preformatted attribute value of a specific resource
+    def attribute_value_for(resource, attribute_name, truncation = 50)
       value = resource.send(attribute_name).to_s.truncate(truncation)
       if attribute_name.to_s.match(/_id$/)
-        model_name = attribute_name.gsub(/_id$/, "").classify
+        model_name = attribute_name.gsub(/_id$/, '').classify
         begin
           value = eval(model_name).find(value).to_s
         rescue ActiveRecord::RecordNotFound
@@ -61,88 +65,32 @@ module PowerResource
       end
       value
     end
-
-    # Returns a text based on action and resource names
-    #
-    # Example:
-    #
-    #   resource_action(:new)
-    #     # => "New Product"
-    def resource_action(action_name)
-      I18n.t("power_resource.resource_actions.#{action_name}",
-             resource_name: resource_human_name,
-             default: "#{action_name.to_s.titleize} #{resource_human_name}")
-    end
-
-    # Returns a link for a resource
-    #
-    # Examples:
-    #
-    #   resource_link(:new) 
-    #     # => <a href="/products/new">New Product</a>
-    #   resource_link(:edit) 
-    #     # => <a href="/products/1/edit">Edit Product</a>
-    #   resource_link(:edit, row)
-    #     # => <a href="/products/1/edit">Edit</a>
-    #   resource_link(:edit, text: "Make changes") 
-    #     # => <a href="/products/1/edit">Make changes</a>
-    def resource_link(action_name)
-      text ||= resource_action(action_name)
-
-      eval("resource_link_for_#{action_name.to_s}(text)")
-
-      case action_name.to_sym
-      when :new
-        link_to(text, new_resource_path)
-      when :edit
-        link_to(text, edit_resource_path(resource))
-      when :delete
-        link_to
-      end
-    end
-
-    # Returns form path for a resource
+    
+    # Returns a form path for a resource
     def resource_form_path
       resource.new_record? ? collection_path : resource_path
     end
 
-    # Renders form using selected form builder
-    def render_form(form_builder = "formtastic")
-      fields = resource_human_attributes
-      fields.map! do |arg|
-        arg.to_s.sub("_id", "").to_sym
+    # Returns associations for a resource
+    def resource_associations(association_type)
+      resource_class.reflect_on_all_associations(association_type).map(&:name)
+    end
+    
+    # Returns association links for a resource
+    def resource_association_links_for(resource, options = {})
+      output = Array.new
+      resource_associations(:has_many).each do |association|
+        text = resource_human_name_for(association, 2)
+        if controller_path.include?('/')
+          namespace = controller.class.parent.name.underscore
+          path = [namespace, resource, association.to_s.tableize]
+        else
+          path = [resource, association.to_s.tableize]
+        end
+        options.merge!(class: collection_table_button_classes)
+        output << link_to(text, path, options)
       end
-      render "power_resource/builders/#{form_builder}", fields: fields
-    end
-
-    # Renders collection table
-    def render_collection_table(custom_attributes = nil)
-      render "collection",
-        collection: collection,
-        attributes: custom_attributes || resource_human_attributes
-    end
-
-    # Renders action links for a resource
-    def render_actions_for(resource)
-      render "actions", resource: resource
-    end
-
-    private
-
-    def resource_link_for_index(text)
-      link_to(text, collection_path)
-    end
-
-    def resource_link_for_show(text)
-      link_to(text, resource_path(resource))
-    end
-
-    def resource_link_for_new(text)
-      link_to(text, new_resource_path)
-    end
-
-    def resource_link_for_edit(text)
-      link_to(text, edit_resource_path(resource))
+      output.join(' ').html_safe
     end
   end
 end