index_for 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea4e0afe260da5eec24621e4bd92dd33be8324b1
+  data.tar.gz: e227a16664cc72ad69259e5a0e70344d30744e29
+SHA512:
+  metadata.gz: eadee2671a17f880efdb5b007b35156a4180e3b62cc5a36416bc02dfc867df4cc7609c809e1166730ae5b59214f900628ae1585bd85d351972654b65617aed72
+  data.tar.gz: bd245387e4eb295aa3f3f482f0a8bb37a93af756437c2a3e74809d1ef9df6d88d3f17ec1c7c50a2eecd26f0569a7cc2bdd27e70d49bc9ea23ddb4ce6c68134f5

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+desc 'Test the index_for plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+# If you want to make this the default task
+task :default => :test

data/lib/generators/index_for/USAGE

@@ -0,0 +1,3 @@
+To copy a IndexFor initializer to your Rails App, with some configuration values, just do:
+
+    rails generate index_for:install

data/lib/generators/index_for/install_generator.rb

@@ -0,0 +1,22 @@
+module IndexFor
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Copy IndexFor installation files"
+      class_option :template_engine, :desc => 'Template engine to be invoked (erb or haml or slim).'
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_initializers
+        copy_file 'index_for.rb', 'config/initializers/index_for.rb'
+      end
+
+      def copy_locale_file
+        copy_file 'en.yml', 'config/locales/index_for.en.yml'
+      end
+
+      def copy_generator_template
+        engine = options[:template_engine]
+        copy_file "index.html.#{engine}", "lib/templates/#{engine}/scaffold/index.html.#{engine}"
+      end
+    end
+  end
+end

data/lib/generators/index_for/templates/en.yml

@@ -0,0 +1,14 @@
+en:
+  index_for:
+    blank: "Not specified"
+    # If you want to use html tags with blank value use blank html translation
+    # blank_html: "<span>Not specified</span>"
+    "yes": "Yes"
+    "no": "No"
+    actions:
+      actions: Actions
+      show: Show
+      new: New
+      edit: Edit
+      destroy: Destroy
+      confirmation: "Are you sure?"

data/lib/generators/index_for/templates/index.html.erb

@@ -0,0 +1,8 @@
+<%%= index_for @<%= plural_name %> do |i| %>
+<% attributes.each do |attribute| -%>
+  <%%= i.<%= attribute.reference? ? :association : :attribute %> :<%= attribute.name %> %>
+<% end -%>
+  <%%= i.actions :all %>
+<%% end %>
+
+<%%= link_to 'New', new_<%= singular_name %>_path(@<%= singular_name %>) %>

data/lib/generators/index_for/templates/index.html.haml

@@ -0,0 +1,7 @@
+= index_for(@<%= plural_name %>) do |i|
+<%- attributes.each do |attribute| -%>
+  = i.<%= attribute.reference? ? :association : :attribute %> :<%= attribute.name %>
+<% end -%>
+  = i.actions :all
+
+= link_to 'New', new_<%= singular_name %>_path(@<%= singular_name %>)

data/lib/generators/index_for/templates/index_for.rb

@@ -0,0 +1,24 @@
+# Use this setup block to configure all options available in IndexFor.
+IndexFor.setup do |config|
+  # The tag which wraps index_for calls.
+  # config.index_for_tag = :div
+
+  # The DOM class set for index_for tag. Default is nil
+  # config.index_for_class = :custom
+  
+  # The tag which wraps header call. Default is :thead, set nil to turn off header.
+  # config.head_tag = nil
+
+  # The tag which wraps body call. Default is :tbody.
+  # config.body_tag = :ul
+
+  # The tag which wraps each head column call. Default is :th.
+  # config.head_column_tag = :li
+
+  # The tag which wraps each body column call. Default is :td.
+  # config.body_column_tag = :li
+
+  # The tag which wraps each row call. Default is :tr.
+  # config.row_tag = :p
+  
+end

data/lib/index_for/attribute.rb

@@ -0,0 +1,30 @@
+module IndexFor
+  module Attribute
+
+    private
+
+    def attribute_value attribute_name, options
+      attribute_name = options[:value] if options[:value]
+      attribute_name = :"#{attribute_name}.#{options[:with]}" if options[:with]
+
+      parts = attribute_name.to_s.split(".")
+      attribute_name = parts.pop
+
+      object = @object
+      parts.each do |attribute_name|
+        object = object.send(attribute_name)
+      end if parts.any?
+
+      if object.respond_to?(:"human_#{attribute_name}")
+        object.send :"human_#{attribute_name}"
+      else
+        object.send(attribute_name)
+      end
+    end
+
+    def attribute_label attribute_name
+      @object.class.human_attribute_name(attribute_name)
+    end
+
+  end
+end

data/lib/index_for/builder.rb

@@ -0,0 +1,118 @@
+require 'index_for/attribute'
+
+module IndexFor
+  class Builder
+    include IndexFor::ShareHelper
+    include IndexFor::Attribute
+    
+    attr_accessor :object, :html_options, :template
+
+    def initialize object, html_options, template
+      @object, @html_options, @template = object, html_options, template
+    end
+
+    def attribute attribute_name, options = {}, █ end
+    def association attribute_name, options = {}, &block
+      attribute attribute_name, options, &block
+    end
+
+    def attributes *attribute_names
+      options = attribute_names.extract_options!
+
+      attribute_names.map do |attribute_name|
+        attribute attribute_name, options
+      end.join.html_safe
+    end
+
+    def actions *action_names, █ end
+
+    private
+
+    def apply_html type, options = {} #:nodoc:
+      type_tag = html_options[:"#{type}_tag"] || IndexFor.try(:"#{type}_tag")
+      type_html_options = apply_html_options type, options
+
+      return type_tag, type_html_options
+    end
+
+    def apply_html_options type, options = {}
+      type_class = IndexFor.send :"#{type}_class"
+
+      type_html_options = {}
+      type_html_options.merge!(html_options[:"#{type}_html"]) if html_options[:"#{type}_html"]
+      type_html_options.merge!(options[:html]) if options[:html]
+      
+      append_class type_html_options, type_class
+
+      type_html_options
+    end
+
+
+    def wrap_content_with type, content, options = {}, &block #:nodoc:
+      type_tag, type_html_options = apply_html type, options
+      append_class type_html_options, IndexFor.blank_content_class if content.blank?
+
+      @template.content_tag type_tag, type_html_options do
+        format_content(content, options, &block)
+      end
+    end
+
+    def format_content content, options = {}, &block
+      # We need to convert content to_a because when dealing with ActiveRecord
+      # Array proxies, the follow statement Array# === content return false
+      if block && block.arity == 1
+        content = block
+      elsif content.respond_to?(:to_ary)
+        content = content.to_a
+      end
+
+      case content
+      when Date, Time, DateTime
+        I18n.l content, :format => options[:format] || IndexFor.i18n_format
+      when TrueClass
+        translate :"show_for.yes", :default => "Yes"
+      when FalseClass
+        translate :"show_for.no", :default => "No"
+      when Array, Hash
+        content.empty? ? blank_content(options) : 
+          collection_content(content, options, &block)
+      when Proc
+        @template.capture(@object, &content)
+      when NilClass
+        blank_content(options)
+      else
+        content.to_s
+      end
+    end
+
+    def blank_content options
+      options[:if_blank] || translate(:blank, :default => "Not specified")
+    end
+
+    def collection_content collection, options, &block
+      collection_tag = options[:collection_tag] || IndexFor.collection_tag
+      collection_column_tag = options[:collection_column_tag] || IndexFor.collection_column_tag
+      @template.content_tag collection_tag do
+        collection.map do |content|
+          if block
+            @template.capture content, collection, @object, &block
+          else
+            @template.content_tag collection_column_tag, content
+          end
+        end.join.html_safe
+      end
+    end
+
+    # Gets the default tag set in IndexFor module and apply (if defined)
+    # around the given content. It also check for html_options in @options
+    # hash related to the current type.
+    def wrap_with type, content, options = {} #:nodoc:
+      type_tag, type_html_options = apply_html type, options
+      if type_tag
+        @template.content_tag type_tag, content, type_html_options
+      else
+        content
+      end
+    end
+  end
+end

data/lib/index_for/builders/action_builder.rb

@@ -0,0 +1,31 @@
+require 'index_for/builder'
+
+module IndexFor
+  class ActionBuilder < Builder
+
+    def action_link action_name, options = {}, &block
+      if block
+        @template.capture(@object, &block)
+      else
+        action_title = translate(:"actions.#{action_name}", 
+          default: action_name.to_s.humanize).html_safe
+        action_html_options = apply_html_options :action_link, options[:html] || {}
+        append_class action_html_options, :"action_#{action_name}"
+
+        case action_name
+        when :show
+          @template.link_to action_title, @template.polymorphic_path(@object),
+            action_html_options
+        when :destroy
+          @template.link_to action_title, @template.polymorphic_path(@object), 
+            { data: { method: :destroy, confirm: translate(:"actions.confirmation")
+            }}.merge(action_html_options)
+        else
+          @template.link_to action_title, @template.polymorphic_path(@object,
+            action: action_name), action_html_options
+        end
+      end
+    end
+
+  end
+end

data/lib/index_for/builders/body_column_builder.rb

@@ -0,0 +1,23 @@
+require 'index_for/builder'
+
+module IndexFor
+  class BodyColumnBuilder < Builder
+
+    def attribute attribute_name, options = {}, &block
+      append_html_class options, :"attr_#{attribute_name}"
+      wrap_content_with :table_body_cell, attribute_value(attribute_name, 
+        options), options, &block
+    end
+
+    def actions *action_names, &block
+      options = action_names.extract_options!
+      options[:html] = apply_html_options :table_actions_cell, options
+
+      content = @template.index_for_actions @object, *action_names, 
+        options, &block
+
+      wrap_with :table_body_cell, content, options
+    end
+
+  end
+end

data/lib/index_for/builders/head_column_builder.rb

@@ -0,0 +1,19 @@
+require 'index_for/builder'
+
+module IndexFor
+  class HeadColumnBuilder < Builder
+
+    def attribute attribute_name, options = {}
+      append_html_class options, :"attr_#{attribute_name}"
+      wrap_with :table_head_cell, attribute_label(attribute_name), options
+    end
+
+    def actions *action_names
+      options = action_names.extract_options!
+      options[:html] = apply_html_options :table_actions_cell, options
+      
+      wrap_with :table_head_cell, translate(:"actions.actions"), options
+    end
+
+  end
+end

data/lib/index_for/builders/list_column_builder.rb

@@ -0,0 +1,32 @@
+require 'index_for/builder'
+
+module IndexFor
+  class ListColumnBuilder < Builder
+
+    def attribute attribute_name, options = {}, &block
+      label_options = options
+      label_options[:html] = options[:label_html]
+
+      content_options = options
+      content_options[:html] = options[:content_html]
+
+      row_options = options
+      row_options[:html] = options[:row_html]
+
+      wrap_with :list_row, label(attribute_name, label_options) + 
+        content(attribute_name, options, &block), row_options
+    end
+
+    def label attribute_name, options
+      append_html_class options, :"attr_#{attribute_name}"
+      wrap_with :list_label, attribute_label(attribute_name), options
+    end
+
+    def content attribute_name, options, &block
+      append_html_class options, :"attr_#{attribute_name}"
+      wrap_content_with :list_content, attribute_value(attribute_name, 
+        options), options, &block
+    end
+
+  end
+end

data/lib/index_for/helper.rb

@@ -0,0 +1,140 @@
+module IndexFor
+  module Helper
+    include IndexFor::ShareHelper
+
+    # Creates a table around the objects and yields a builder.
+    #
+    # Example:
+    #
+    #   index_for @users do |t|
+    #     t.attribute :name
+    #     t.attribute :email
+    #   end
+    #
+    def index_for objects, html_options = {}, &block
+      html_options = html_options.dup
+
+      tag = html_options[:table_tag] || IndexFor.table_tag
+
+      klass = html_options[:klass] || objects.try(:klass) || objects.first.class
+
+      html_options[:id] ||= index_for_id(klass)
+      html_options[:class] = index_for_class(klass, html_options)
+
+      head = index_for_head(klass.new, html_options, &block)
+      body = index_for_body(objects, html_options, &block)
+      content = head + body
+
+      content_tag(tag, content, html_options)
+    end
+
+    # Create action links and yields a builder.
+    #
+    # Example:
+    #
+    #   index_for_actions @user do |a|
+    #     a.action_link :show
+    #     a.action_link :edit
+    #   end
+    #
+    #   index_for_actions @user, :show, :edit
+    #
+    def index_for_actions object, *action_names, &block
+      html_options = action_names.extract_options!
+      action_names = [:show, :edit, :destroy] if action_names == [:all]
+
+      builder = IndexFor::ActionBuilder.new(object, html_options, self)
+      
+      content = capture(builder) do |a|
+        action_names.map do |action_name|
+          a.action_link action_name
+        end.join.html_safe
+      end
+
+      content += capture(builder, &block) if block
+
+      content
+    end
+
+    # Creates a desc list around the object and yields a builder.
+    #
+    # Example:
+    #
+    #   show_for @user do |l|
+    #     l.attribute :name
+    #     l.attribute :email
+    #   end
+    #
+    def show_for object, html_options = {}, &block
+      html_options = html_options.dup
+
+      tag = html_options[:list_tag] || IndexFor.list_tag
+
+      html_options[:id] ||= show_for_id(object)
+      html_options[:class] = show_for_class(object, html_options)
+
+      content = capture(IndexFor::ListColumnBuilder.new(object, html_options, self), &block)
+
+      content_tag(tag, content, html_options)
+    end
+
+    private
+
+    def index_for_head object, html_options = {}, &block
+      head_tag = html_options[:head_tag] || IndexFor.table_head_tag
+      row_tag = html_options[:row_tag] || IndexFor.table_row_tag
+
+      head_html_options = html_options[:head_html] || {}
+      append_class head_html_options, IndexFor.table_head_class
+
+      row_html_options = html_options[:row_html] || {}
+      append_class row_html_options, IndexFor.table_row_class, dom_class(object)
+
+      content = capture(IndexFor::HeadColumnBuilder.new(object, html_options, self), &block)
+
+      content_tag(head_tag, head_html_options) do
+        content_tag(row_tag, content, row_html_options)
+      end
+    end
+
+    def index_for_body objects, html_options = {}, &block
+      body_tag = html_options[:body_tag] || IndexFor.table_body_tag
+      row_tag = html_options[:row_tag] || IndexFor.table_row_tag
+
+      body_html_options = html_options[:body_html] || {}
+      append_class body_html_options, IndexFor.table_body_class
+
+      content_tag(body_tag, body_html_options) do
+        objects.map do |object|
+          row_html_options = html_options[:row_html] || {}
+          row_html_options[:id] ||= dom_id(object)
+          append_class row_html_options, IndexFor.table_row_class, dom_class(object)
+
+          content = capture(IndexFor::BodyColumnBuilder.new(object, html_options, self), &block)
+          content_tag(row_tag, content, row_html_options)
+        end.join.html_safe
+      end
+    end
+
+    # Finds the class representing the collection
+    # IndexFor
+    def index_for_id klass
+      klass.model_name.plural
+    end
+
+    def index_for_class klass, html_options
+      append_class html_options, "index_for", klass.model_name.plural, IndexFor.table_class
+    end
+
+    # ShowFor
+    def show_for_id object
+      dom_id object
+    end
+
+    def show_for_class object, html_options
+      append_class html_options, "show_for", dom_class(object), IndexFor.table_class
+    end
+  end
+end
+
+ActionView::Base.send :include, IndexFor::Helper

data/lib/index_for/share_helper.rb

@@ -0,0 +1,20 @@
+module IndexFor
+  module ShareHelper
+    private
+
+    def append_class html_options, *classes
+      classes << html_options[:class]
+      classes.compact!
+      html_options[:class] = classes.join(" ") if classes.any?
+    end
+
+    def append_html_class options, *classes
+      options[:html] ||= {}
+      append_class options[:html], *classes
+    end
+
+    def translate i18n_key, options = {}
+      I18n.t(i18n_key, options.reverse_merge(scope: :index_for))
+    end
+  end
+end

data/lib/index_for/version.rb

@@ -0,0 +1,3 @@
+module IndexFor
+  VERSION = "0.0.1"
+end

data/lib/index_for.rb

@@ -0,0 +1,96 @@
+require 'action_view'
+require 'index_for/share_helper'
+require 'index_for/helper'
+
+module IndexFor
+  autoload :Builder, 'index_for/builder'
+  autoload :ActionBuilder, 'index_for/builders/action_builder'
+  autoload :HeadColumnBuilder, 'index_for/builders/head_column_builder'
+  autoload :BodyColumnBuilder, 'index_for/builders/body_column_builder'
+  autoload :ListColumnBuilder, 'index_for/builders/list_column_builder'
+
+  # IndexFor
+  mattr_accessor :table_tag
+  @@table_tag = :table
+  mattr_accessor :table_class
+  @@table_class = nil
+  
+  mattr_accessor :table_head_tag
+  @@table_head_tag = :thead
+  mattr_accessor :table_head_class
+  @@table_head_class = nil
+
+  mattr_accessor :table_body_tag
+  @@table_body_tag = :tbody
+  mattr_accessor :table_body_class
+  @@table_body_class = nil
+
+  mattr_accessor :table_row_tag
+  @@table_row_tag = :tr
+  mattr_accessor :table_row_class
+  @@table_row_class = nil
+
+  mattr_accessor :table_head_cell_tag
+  @@table_head_cell_tag = :th
+  mattr_accessor :table_head_cell_class
+  @@table_head_cell_class = nil
+  
+  mattr_accessor :table_body_cell_tag
+  @@table_body_cell_tag = :td
+  mattr_accessor :table_body_cell_class
+  @@table_body_cell_class = nil
+
+  mattr_accessor :table_actions_cell_class
+  @@table_actions_cell_class = :actions
+
+  mattr_accessor :action_link_class
+  @@action_link_class = :action
+
+  # ShowFor
+  mattr_accessor :list_tag
+  @@list_tag = :dl
+  mattr_accessor :list_class
+  @@list_class = nil
+
+  mattr_accessor :list_row_tag
+  @@list_row_tag = nil
+  mattr_accessor :list_row_class
+  @@list_row_class = nil
+
+  mattr_accessor :list_label_tag
+  @@list_label_tag = :dt
+  mattr_accessor :list_label_class
+  @@list_label_class = nil
+
+  mattr_accessor :list_content_tag
+  @@list_content_tag = :dd
+  mattr_accessor :list_content_class
+  @@list_content_class = nil
+
+  mattr_accessor :list_label_proc
+  @@list_label_proc = nil
+
+  mattr_accessor :blank_content_class
+  @@blank_content_class = "blank"
+
+  mattr_accessor :i18n_format
+  @@i18n_format = :default
+
+  mattr_accessor :association_methods
+  @@association_methods = [ :name, :title, :to_s ]
+
+  mattr_accessor :collection_tag
+  @@collection_tag = :ul
+  mattr_accessor :collection_column_tag
+  @@collection_column_tag = :li
+
+  # Yield self for configuration block:
+  #
+  #   IndexFor.setup do |config|
+  #     config.index_for_tag = :div
+  #   end
+  #
+  def self.setup
+    yield self
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: index_for
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Theo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: Wrap your objects with a helper to easily list them
+email:
+- bbtfrr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/generators/index_for/USAGE
+- lib/generators/index_for/install_generator.rb
+- lib/generators/index_for/templates/en.yml
+- lib/generators/index_for/templates/index.html.erb
+- lib/generators/index_for/templates/index.html.haml
+- lib/generators/index_for/templates/index_for.rb
+- lib/index_for.rb
+- lib/index_for/attribute.rb
+- lib/index_for/builder.rb
+- lib/index_for/builders/action_builder.rb
+- lib/index_for/builders/body_column_builder.rb
+- lib/index_for/builders/head_column_builder.rb
+- lib/index_for/builders/list_column_builder.rb
+- lib/index_for/helper.rb
+- lib/index_for/share_helper.rb
+- lib/index_for/version.rb
+homepage: https://github.com/bbtfr/index_for
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Wrap your objects with a helper to easily list them
+test_files: []