power_resource 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e0f9fc6dee728f9630996271a5beed85771e9cd
+  data.tar.gz: d702eaa22dacbb157e5e1308c866a95eec5546fd
+SHA512:
+  metadata.gz: fcf0b8d8ec2a666215b8cdc04bf719ffc41bb9e3b4fe383c70a9572c7cc7ed8a76738d21e5463f7bfc785ed3312afbc799cf46ff400c2b0fe977480a51b5835d
+  data.tar.gz: 2644d8ca0872750688a129c21f2666f29fd07cdcc1ad2c4eac867e4bb2785befab282d2e7b54eb1931374d664c46c7d82de21a5c576e7fe46aba88b2edb59bbc

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'inherited_resources', github: 'josevalim/inherited_resources'
+gem 'formtastic'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jari Jokinen
+
+MIT License
+
+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,46 @@
+# PowerResource
+
+Power up your RESTful resources!
+
+ALPHA STAGE, DO NOT USE IN PRODUCTION!
+
+## Requirements
+
+* Ruby 2.0.0 or greater
+* Rails 4.0.0 or greater
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'power_resource'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install power_resource
+
+## Usage
+
+Inherit your resource controllers from PowerResource::BaseController:
+
+    class ProductsController < PowerResource::BaseController
+    end
+
+## Helpers
+
+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).
+
+## 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.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Run RSpec'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/app/controllers/power_resource/base_controller.rb

@@ -0,0 +1,30 @@
+module PowerResource
+  class BaseController < ::ApplicationController
+    inherit_resources
+    defaults route_prefix: ''
+
+    def create
+      create! { collection_url }
+    end
+
+    def update
+      update! { collection_url }
+    end
+
+    protected
+
+    def resource_name
+      controller_name.tableize.singularize.to_sym
+    end
+
+    def permitted_params
+      params.permit(
+        resource_name => resource_class.attribute_names - denied_params
+      )
+    end
+
+    def denied_params
+      %w(id created_at updated_at)
+    end
+  end
+end

data/app/helpers/power_resource/base_helper.rb

@@ -0,0 +1,148 @@
+module PowerResource
+  module BaseHelper
+    # Returns humanized and localized name for a current resource model
+    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}"
+    end
+
+    # Returns a title for a collection
+    def collection_title
+      I18n.t("activemodel.models.#{controller_name.singularize}.other",
+        default: controller_name.humanize)
+    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)
+    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?")
+        parent_attribute = "#{parent.class.name.underscore}_id"
+        human_attributes = human_attributes - ["#{parent_attribute}"]
+      end
+      human_attributes
+    end
+
+    # Returns humanized and localized attribute name
+    def attribute_human_name(attribute_name)
+      attribute_name = attribute_name.to_s
+      I18n.t("activerecord.attributes.#{controller_name.singularize}.#{attribute_name}",
+        default: attribute_name.humanize)
+    end
+
+    # Returns truncated attribute value
+    def attribute_value(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
+        begin
+          value = eval(model_name).find(value).to_s
+        rescue ActiveRecord::RecordNotFound
+          value = ""
+        end
+      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
+    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
+      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))
+    end
+  end
+end

data/app/views/power_resource/base/_actions.html.erb

@@ -0,0 +1 @@
+<%= link_to(t('actions.edit'), edit_resource_path(resource)) %>

data/app/views/power_resource/base/_collection.html.erb

@@ -0,0 +1,28 @@
+<% @title ||= collection_title %>
+
+<table>
+  <thead>
+    <tr>
+      <% attributes.each do |attribute_name| %>
+        <th><%= attribute_human_name(attribute_name) %></th>
+      <% end %>
+      <th>&nbsp;</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% collection.each do |resource| %>
+      <tr>
+        <% attributes.each do |attribute_name| %>
+          <td><%= attribute_value(resource, attribute_name) %></td>
+        <% end %>
+        <td class="actions"><%= render_actions_for(resource) %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<%=
+  if defined?(Kaminari)
+    paginate(collection)
+  end
+%>

data/app/views/power_resource/base/_form.html.erb

@@ -0,0 +1 @@
+<%= render_form %>

data/app/views/power_resource/base/edit.html.erb

@@ -0,0 +1,3 @@
+<% @title ||= resource_action(:edit) %>
+
+<%= render 'form' %>

data/app/views/power_resource/base/index.html.erb

@@ -0,0 +1,9 @@
+<% @title ||= collection_title %>
+
+<%=
+  unless collection.blank?
+    render_collection_table
+  end
+%>
+
+<%= resource_link(:new) %>

data/app/views/power_resource/base/new.html.erb

@@ -0,0 +1,3 @@
+<% @title ||= resource_action(:new) %>
+
+<%= render 'form' %>

data/app/views/power_resource/builders/_form_for.html.erb

@@ -0,0 +1,23 @@
+<% if resource.errors.any? %>
+  <div id="error_explanation">
+    <%= pluralize(resource.errors.count, "error") %>
+    prohibited this resource from being saved:
+    <ul>
+      <% resource.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+    </ul>
+  </div>
+<% end %>
+
+<%= form_for(resource, url: resource_form_path) do |f| %>
+  <ul>
+    <% fields.each do |field| %>
+      <li>
+        <%= f.label(field) %>
+        <%= f.text_field(field) %>
+      </li>
+    <% end %>
+  </ul>
+  <%= f.submit %>
+<% end %>

data/app/views/power_resource/builders/_formtastic.html.erb

@@ -0,0 +1,4 @@
+<%= semantic_form_for(resource, url: resource_form_path) do |f| %>
+  <%= f.inputs(*fields) %>
+  <%= f.actions %>
+<% end %>

data/lib/power_resource.rb

@@ -0,0 +1,6 @@
+require 'inherited_resources'
+require 'power_resource/engine'
+require 'power_resource/version'
+
+module PowerResource
+end

data/lib/power_resource/engine.rb

@@ -0,0 +1,4 @@
+module PowerResource
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/power_resource/version.rb

@@ -0,0 +1,3 @@
+module PowerResource
+  VERSION = '0.0.1'
+end

data/power_resource.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'power_resource/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'power_resource'
+  spec.version       = PowerResource::VERSION
+  spec.authors       = ['Jari Jokinen']
+  spec.email         = ['info@jarijokinen.com']
+  spec.description   = 'Power up your RESTful resources!'
+  spec.summary       = 'Power up your RESTful resources!'
+  spec.homepage      = 'https://github.com/jarijokinen/power_resource'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ['lib']
+
+  spec.platform = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_dependency 'rails', '~> 4.0.0'
+  spec.add_dependency 'inherited_resources', '~> 1.4.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'capybara', '2.1.0'
+  spec.add_development_dependency 'rake', '10.1.0'
+  spec.add_development_dependency 'rspec-rails', '2.14.0'
+  spec.add_development_dependency 'sqlite3', '1.3.7'
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.