acts_as_indexable 0.0.1

data/acts_as_indexable.gemspec

@@ -0,0 +1,31 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "acts_as_indexable/version"
+
+Gem::Specification.new do |s|
+  s.name          = "acts_as_indexable"
+  s.version       = ActsAsIndexable::VERSION
+  s.authors       = ["Taylor C. MacDonald"]
+  s.email         = ["tcmacdonald@gmail.com"]
+  s.homepage      = "https://github.com/tcmacdonald/acts_as_indexable"
+  s.summary       = "Utilities for building and extending table views in your Rails application."
+  s.description   = "ActsAsIndexable is a Rails engine that provides a configurable DSL for rendering tables in index views of your application. It works with any collection of enumerable objects, ActiveRecord or otherwise."
+  s.license       = "MIT"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ['lib','app']
+
+  s.add_runtime_dependency 'rails', '~> 4.2', '>= 4.2.3'
+
+  s.add_development_dependency 'sqlite3', '~> 1.3', '>= 1.3.11'
+  s.add_development_dependency 'rspec-rails', '~> 3.4', '>= 3.4.0'
+  s.add_development_dependency 'shoulda-matchers', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'database_cleaner', '~> 1.4', '>= 1.5.1'
+  s.add_development_dependency 'guard-rspec', '~> 4.6', '>= 4.6.4'
+  s.add_development_dependency 'launchy', '~> 2.4', '>= 2.4.3'
+  s.add_development_dependency 'capybara', '~> 2.5', '>= 2.5.0'
+  s.add_development_dependency 'capybara-webkit', '~> 1.7', '>= 1.7.1'
+  s.add_development_dependency 'factory_girl_rails', '~> 4.5', '>= 4.5.0'
+  s.add_development_dependency 'pry', '~> 0.10', '>= 0.10.3'
+
+end

data/app/helpers/acts_as_indexable/acts_as_indexable_helper.rb

@@ -0,0 +1,12 @@
+module ActsAsIndexable
+  module ActsAsIndexableHelper
+
+    def render_indexable(collection, **opts)
+      render partial: 'acts_as_indexable/index',
+             object: collection,
+             as: :collection,
+             locals: { opts: opts }
+    end
+
+  end
+end

data/app/views/acts_as_indexable/_index.html.erb

@@ -0,0 +1,9 @@
+<%= content_tag :table, local_assigns.try(:[], :opts) do %>
+  <%= render 'acts_as_indexable/thead' %>
+  <% if local_assigns[:collection].present? %>
+    <tbody>
+      <%= render partial: 'acts_as_indexable/row', collection: local_assigns[:collection] %>
+    </tbody>
+  <% end %>
+<% end %>
+

data/app/views/acts_as_indexable/_row.html.erb

@@ -0,0 +1,15 @@
+  <tr id="<%= dom_id(row) %>">
+  <% decorated_attrs.each do |attr|  %>
+    <%= content_tag :td, class: attr.try(:klass) do %>
+      <% if attr.partial.present? %>
+        <%= render partial: attr.partial, object: row %>
+      <% else %>
+        <% if attr.key == :actions %>
+          <%= attr.link_to_actions(row) %>
+        <% else %>
+          <%= link_to_if attr.path.present?, attr.l(row), attr.href(row) %>
+        <% end %>
+      <% end %>
+    <% end %>
+  <% end %>
+  </tr>

data/app/views/acts_as_indexable/_thead.html.erb

@@ -0,0 +1,7 @@
+  <thead>
+    <tr>
+    <% decorated_attrs.each do |attr|  %>
+      <th><%= attr.label %></th>
+    <% end %>
+    </tr>
+  </thead>

data/lib/acts_as_indexable.rb

@@ -0,0 +1,7 @@
+require 'acts_as_indexable/attribute'
+require 'acts_as_indexable/engine'
+require 'acts_as_indexable/version'
+require 'acts_as_indexable/view'
+
+module ActsAsIndexable
+end

data/lib/acts_as_indexable/attribute.rb

@@ -0,0 +1,59 @@
+module ActsAsIndexable
+  class Attribute
+    include ActionView::Helpers::UrlHelper
+
+    attr_accessor :key,
+                  :label,
+                  :attrs,
+                  :format,
+                  :partial,
+                  :path
+
+    def initialize(key, attrs={})
+      @key = key
+      @attrs = attrs
+      @label = @attrs.try(:[], :label) || @key.to_s.humanize
+      @path = @attrs.try(:[], :link_to)
+      @format = @attrs.try(:[], :format)
+      @partial = @attrs.try(:[], :partial)
+    end
+
+    def l(ctx)
+      if @format.present?
+        I18n.l ctx.send(@key), format: @format
+      else
+        ctx.send(@key)
+      end
+    end
+
+    def href(ctx, href=nil)
+      path = href || @path
+      if path.present?
+        if path.to_s == 'self'
+          ctx
+        else
+          path.scan(/:[a-z_]*/).each do |attr|
+            path = path.gsub(/#{attr}/, ctx.send(attr[1..-1].to_sym).to_s)
+          end
+          path
+        end
+      end
+    end
+
+    def link_to_actions(ctx)
+      @attrs.to_h.collect do |k,v|
+        label = v.try(:[], :label) || k.to_s.humanize
+        opts = {}
+        if k == :delete
+          opts[:data] = { method: :delete, confirm: 'Are you sure?' }
+          path = v.try(:[], :link_to) || "/#{ctx.class.name.underscore.pluralize}/:id"
+        else
+          path = v.try(:[], :link_to) || "/#{ctx.class.name.underscore.pluralize}/:id/#{k}"
+        end
+
+        link_to label, href(ctx, path), opts.merge(v.except(:link_to, :label))
+      end.join().html_safe
+    end
+
+  end
+end

data/lib/acts_as_indexable/engine.rb

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

data/lib/acts_as_indexable/version.rb

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

data/lib/acts_as_indexable/view.rb

@@ -0,0 +1,26 @@
+module ActsAsIndexable
+  module View
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :decorated_attrs
+    end
+
+    protected
+
+      def current_attrs
+        @current_attrs ||= {
+          id: {},
+          to_s: {},
+          created_at: {},
+        }
+      end
+
+      def decorated_attrs
+        @decorated_attrs ||= current_attrs.collect do |k,v|
+          Attribute.new k, OpenStruct.new(v)
+        end
+      end
+
+  end
+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>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/javascripts/widgets.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/assets/stylesheets/widgets.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/widgets_controller.rb

@@ -0,0 +1,18 @@
+class WidgetsController < ApplicationController
+  include ActsAsIndexable::View
+
+  protected
+
+    def current_attrs
+      {
+        id: {},
+        title: { link_to: :self },
+        body: {},
+        actions: {
+          edit: {},
+          delete: {}
+        }
+      }
+    end
+
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/helpers/widgets_helper.rb

@@ -0,0 +1,2 @@
+module WidgetsHelper
+end

data/spec/dummy/app/models/widget.rb

@@ -0,0 +1,3 @@
+class Widget < ActiveRecord::Base
+  alias_attribute :to_s, :title
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css" integrity="sha512-dTfge/zgoMYpP7QbHy4gWMEGsbsdZeCXz7irItjcC3sPUFtf0kuFbDz/ixG7ArTxmDjLXDmezHubeNikyKGVyQ==" crossorigin="anonymous">
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<div class="container">
+  <%= yield %>
+</div>
+
+</body>
+</html>

data/spec/dummy/app/views/widgets/_date.html.erb

@@ -0,0 +1 @@
+<%= date.created_at.strftime('%B %Y') %>

data/spec/dummy/app/views/widgets/index.html.erb

@@ -0,0 +1,4 @@
+<h1>Widgets#index</h1>
+
+<%= render_indexable Widget.all, class: 'table table-striped' %>
+

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment', __FILE__)
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,32 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "acts_as_indexable"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3