e9_attributes 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in e9_attributes.gemspec
+gemspec

data/README.md

@@ -0,0 +1,4 @@
+E9 Attributes
+=============
+
+Searchable attributes engine

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/app/controllers/e9_attributes/menu_options_controller.rb

@@ -0,0 +1,27 @@
+class E9Attributes::MenuOptionsController < Admin::ResourceController
+  include E9Rails::Controllers::Sortable
+  include E9Rails::Helpers::ResourceLinks
+
+  defaults :resource_class => MenuOption, :route_prefix => nil
+  has_scope :options_for, :as => :key, :only => :index
+
+  # NOTE The reason this is set in a filter instead of just a default scope value 
+  #      is that it is used in the index view to add the key param to the new 
+  #      resource link
+  #
+  before_filter :ensure_default_fetch_key, :only => :index
+
+  def create
+    create! { collection_path(:key => resource.key) }
+  end
+
+  def update
+    update! { collection_path(:key => resource.key) }
+  end
+
+  protected
+
+  def ensure_default_fetch_key
+    params[:key] ||= MenuOption.keys.sort.first
+  end
+end

data/app/models/menu_option.rb

@@ -0,0 +1,41 @@
+# A simple class to manage menu options, usable by other classes to build their menus.
+#
+class MenuOption < ActiveRecord::Base
+  class_inheritable_accessor :keys
+
+  def self.initialize_keys!(*keys)
+    return self.keys unless self.keys.nil?
+
+    keys.flatten!
+    keys.map!(&:to_s)
+
+    self.keys = keys
+    validates :key, :presence  => true, :inclusion => { :in => keys, :allow_blank => true }
+  end
+
+  validates :value, :presence  => true
+
+  acts_as_list :scope => 'menu_options.key = \"#{key}\"'
+
+  scope :options_for, lambda {|key| where(:key => key).order('menu_options.position ASC') }
+
+  ##
+  # A direct SQL selection of values for a given key
+  #
+  #   MenuOption.fetch('Email') #=> ['Personal','Work']
+  #
+  # === Parameters
+  #
+  # [key (String)] The key for the assocated menu options.
+  #
+  def self.fetch_values(key)
+    connection.send(:select_values, options_for(key).order(:position).project('value').to_sql, 'Menu Option Select')
+  end
+
+  def to_s
+    value
+  end
+
+  # For e9 admin
+  def role; 'administrator' end
+end

data/app/models/record_attribute.rb

@@ -0,0 +1,51 @@
+# An arbitrary 'attribute' attachable to records.  
+#
+# Gets support for arbitrary options via InheritableOptions.  By default it 
+# has one option, +type+, but subclasses could extend for further options by
+# overwriting +options_parameters+.
+#
+# By default, the +type+ options are managed via the +MenuOption+ class.
+#
+class RecordAttribute < ActiveRecord::Base
+  include E9Rails::ActiveRecord::STI
+  include E9Rails::ActiveRecord::AttributeSearchable
+  include E9Rails::ActiveRecord::InheritableOptions
+
+  PARTIAL_PATH   = 'e9_attributes/record_attributes'
+  FORM_PARTIAL   = PARTIAL_PATH + '/form_partial'
+  LAYOUT_PARTIAL = PARTIAL_PATH + '/record_attribute'
+  TEMPLATES      = PARTIAL_PATH + '/templates'
+  
+  self.options_parameters = [:type]
+  self.delegate_options_methods = true
+
+  belongs_to :record, :polymorphic => true
+
+  scope :search, lambda {|query|
+    where(arel_table[:value].matches('%query%'))
+  }
+
+  ##
+  # Looks up the available +types+ for this attribute by fetching a 
+  # titleized version of the class name from +MenuOption+.
+  #
+  # e.g.
+  #   
+  #   PhoneNumberAttribute.types
+  #
+  # is equivalent to:
+  #
+  #   MenuOption.fetch_values('Phone Number')
+  #
+  def self.types
+    if name =~ /^(\w+)Attribute$/ 
+      MenuOption.fetch_values($1.titleize)
+    else 
+      []
+    end
+  end
+
+  def to_s
+    options.type ? "#{value} (#{options.type})" : value
+  end
+end

data/app/views/e9_attributes/menu_options/_form.html.haml

@@ -0,0 +1,12 @@
+= form_for resource, :url => polymorphic_path([parent, resource]), :remote => request.xhr? do |f|
+  .errors= resource_error_messages!
+
+  .field
+    = f.label :key
+    = f.select :key, MenuOption.keys.sort
+  .field
+    = f.label :value, nil, :class => :req
+    = f.text_field :value
+
+  .actions
+    = f.submit

data/app/views/e9_attributes/menu_options/_table.html.haml

@@ -0,0 +1,24 @@
+- field_map = { :fields => { :position => proc { '<div class="handle">+</div>'.html_safe }, :value => nil, :key => nil } }
+
+%table.sortable
+  %thead
+    %tr
+      - field_map[:fields].keys.each do |key|
+        - if key.is_a?(Symbol)
+          %th= resource_class.human_attribute_name(key)
+        - else
+          %th= orderable_column_link(key)
+      %th= e9_t(:actions)
+  %tbody
+    - if collection.empty?
+      %tr
+        %td{:colspan => field_map[:fields].length + 1}= e9_t(:no_records_text)
+    - else
+      - collection.each do |record|
+        %tr{:id => "ids_#{record.id}", :class => cycle('odd', 'even')}
+          - field_map[:fields].each do |key, value|
+            %td{:class => "record-#{key.to_s.dasherize}"}
+              = value.respond_to?(:call) ? value.call(record) : record.send(key)
+          %td.links
+            = link_to_edit_resource(record)
+            = link_to_destroy_resource(record)

data/app/views/e9_attributes/menu_options/edit.html.haml

@@ -0,0 +1,2 @@
+= title @edit_title || e9_t(:edit_title)
+= render 'form'

data/app/views/e9_attributes/menu_options/index.html.haml

@@ -0,0 +1,13 @@
+= title (@index_title || e9_t(:index_title))
+
+.toolbar
+  .toolbar-left
+    %form{:action => menu_options_path, :method => :get, :class => 'scope-selects'}
+      = label_tag 'menu_option_key_select', t(:view)
+      = select_tag 'key', options_for_select(MenuOption.keys.sort, params[:key])
+  .toolbar-right
+    = link_to_new_resource(MenuOption, :menu_option => {:key => params[:key]}, :class => 'new-menu-option')
+
+= form_tag polymorphic_path([:update_order, resource_class]) do
+  %div#records_table
+    = render 'table', :resources => collection

data/app/views/e9_attributes/menu_options/index.js.erb

@@ -0,0 +1 @@
+$("table.records").replaceWith("<%= escape_javascript(render('table', :collection => collection)) %>");  

data/app/views/e9_attributes/menu_options/new.html.haml

@@ -0,0 +1,2 @@
+= title @new_title || e9_t(:new_title)
+= render 'form'

data/app/views/e9_attributes/menu_options/show.html.haml

@@ -0,0 +1,2 @@
+= title @show_title || e9_t(:show_title)
+= render resource

data/app/views/e9_attributes/record_attributes/_form_partial.html.haml

@@ -0,0 +1,4 @@
+%fieldset.nested-associations
+  %legend= form.label(association_name)
+  = render_record_attribute_association(association_name, form)
+  = link_to_add_record_attribute(association_name)

data/app/views/e9_attributes/record_attributes/_record_attribute.html.haml

@@ -0,0 +1,10 @@
+.record-attribute.nested-association
+  - if f.object.persisted?
+    = f.hidden_field :id
+    = f.hidden_field :_destroy, :value => 0
+  .field
+    = f.send local_assigns[:value_field_type] || :text_field,  :value
+
+  = @nested_association_options
+
+  = link_to_destroy_record_attribute

data/app/views/e9_attributes/record_attributes/templates.js.erb

@@ -0,0 +1,12 @@
+E9A = window.E9A || {};
+E9A.js_templates = {};
+E9A.js_templates.start_child_index = 
+E9A.js_templates.current_child_index = <%= child_index = 100000 %>;
+<%= fields_for(resource) do |f| %>
+  <% resource_class.record_attributes.each do |association_name| %>
+    <% build_associated_resource(association_name) %>
+    <%= f.fields_for(association_name, :child_index => child_index) do |association_form_builder| %>
+E9A.js_templates.<%= association_name %> = "<%= escape_javascript(record_attribute_template(association_name, association_form_builder)) %>";
+    <% end %>
+  <% end %>
+<% end %>

data/config/locales/en.yml

@@ -0,0 +1,6 @@
+en:
+  view: View
+  e9_attributes:
+    add_record_attribute: Add
+    destroy_record_attribute: Remove
+

data/config/routes.rb

@@ -0,0 +1,15 @@
+Rails.application.routes.draw do
+  base_path = 'admin'
+
+  scope :path => base_path, :module => :e9_attributes do
+    resources :menu_options, :except => [:show] do
+      collection { post :update_order }
+    end
+
+    %w(
+      menu_options
+    ).each do |path|
+      get "/#{path}/:id", :to => redirect("/#{base_path}/#{path}/%{id}/edit"), :constraints => { :id => /\d+/ }
+    end
+  end
+end

data/e9_attributes.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "e9_attributes/version"
+
+Gem::Specification.new do |s|
+  s.name        = "e9_attributes"
+  s.version     = E9Attributes::VERSION
+  s.authors     = ["Travis Cox"]
+  s.email       = ["numbers1311407@gmail.com"]
+  s.homepage    = "http://github.com/e9digital/e9_attributes"
+  s.summary     = %q{Searchable attributes}
+  s.description = File.open('README.md').read rescue nil
+
+  s.rubyforge_project = "e9_attributes"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/e9_attributes.rb

@@ -0,0 +1,24 @@
+require "rails"
+require "e9_base"
+require "e9_attributes/version"
+
+module E9Attributes
+  autoload :VERSION, 'e9_attributes/version'
+  autoload :Model,   'e9_attributes/model'
+
+  def E9Attributes.init!
+    ActiveRecord::Base.send(:include, E9Attributes::Model)
+  end
+
+  class Engine < ::Rails::Engine
+    config.e9_attributes = E9Attributes
+    config.to_prepare { E9Attributes.init! }
+
+    initializer 'e9_attributes.include_base_helper' do
+      ActiveSupport.on_load(:action_view) do
+        require 'e9_attributes/helper'
+        include E9Attributes::Helper
+      end
+    end
+  end
+end

data/lib/e9_attributes/helper.rb

@@ -0,0 +1,46 @@
+module E9Attributes::Helper
+
+  def link_to_add_record_attribute(association_name)
+    content_tag :span, t(:add_record_attribute, :scope => :e9_attributes), :class => 'add-nested-association', 'data-association' => association_name
+  end
+
+  def link_to_destroy_record_attribute
+    content_tag :span, t(:destroy_record_attribute, :scope => :e9_attributes), :class => 'destroy-nested-association'
+  end
+
+  def render_record_attribute_form(association_name, form)
+    render(RecordAttribute::FORM_PARTIAL, {
+      :form             => form,
+      :association_name => association_name
+    })
+  end
+
+  def render_record_attribute_association(association_name, form, options = {})
+    options.symbolize_keys!
+
+    association = resource.send(association_name)
+
+    unless association.empty?
+      form.fields_for(association_name) do |f|
+        concat record_attribute_template(association_name, f, options)
+      end
+    end
+  end
+
+  def record_attribute_template(association_name, builder, options = {})
+    options.symbolize_keys!
+
+    render(
+      :partial => options[:partial] || "record_attributes/#{association_name.to_s.singularize}",
+      :locals => { :f => builder }
+    )
+  end
+
+  # tries to build an associated resource, looking to the assocatiaon's model for a method
+  # named "%{association_name}_build_parameters}" first for any default params
+  def build_associated_resource(association_name)
+    params_method = "#{association_name}_build_parameters"
+    build_params = resource_class.send(params_method) if resource_class.respond_to?(params_method)
+    resource.send(association_name).build(build_params || {})
+  end
+end

data/lib/e9_attributes/model.rb

@@ -0,0 +1,39 @@
+module E9Attributes::Model
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def has_record_attributes(*attributes)
+      options = attributes.extract_options!
+
+      class_inheritable_accessor :record_attributes
+      self.record_attributes = attributes.flatten.map do |a|
+        a = a.to_s.classify
+        a = a =~ /Attribute$/ ? a : "#{a}Attribute"
+        a.constantize rescue next
+        a.underscore.pluralize
+      end.compact
+
+      has_many :record_attributes, :as => :record
+
+      self.record_attributes.each do |association_name|
+        has_many association_name.to_sym, :class_name => association_name.classify, :as => :record
+        accepts_nested_attributes_for association_name.to_sym, :allow_destroy => true, :reject_if => :reject_record_attribute?
+      end
+    end
+  end
+
+  def build_all_record_attributes
+    record_attributes.each do |attr|
+      params_method = "#{attr}_build_parameters"
+      build_params = self.class.send(params_method) if self.class.respond_to?(params_method)
+      send(attr).send(:build, build_params || {})
+    end
+  end
+
+  protected
+
+    def reject_record_attribute?(attributes)
+      attributes.keys.member?('value') && attributes['value'].blank?
+    end
+
+end

data/lib/e9_attributes/version.rb

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

data/lib/generators/e9_attributes/install_generator.rb

@@ -0,0 +1,32 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module E9Attributes
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('templates', File.dirname(__FILE__))
+
+      def self.next_migration_number(dirname) #:nodoc:
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def generate_migrations
+        migration_template 'migration.rb', 'db/migrate/create_e9_attributes.rb'
+      end
+
+      def copy_initializer
+        copy_file 'initializer.rb', 'config/initializers/e9_attributes.rb'
+      end
+
+      def copy_javascript
+        copy_file 'javascript.js', 'public/javascripts/e9_attrubutes.js'
+      end
+    end
+  end
+end

data/lib/generators/e9_attributes/templates/javascript.js

@@ -0,0 +1,60 @@
+;jQuery(function($) {
+
+  /*
+   * change the value of the new menu option type link when the scope select
+   * changes, e.g. when viewing "Email" menu options, clicking "Add Menu Option"
+   * defaults to creating a new email menu option.
+   */
+  $('body.admin a.new-menu-option').bind('scope-select:change:key', function(e, v) {
+    $(this).attr('href', function(i, val) {
+      return val.replace(/\[key\]=([^&]*)/, '[key]='+encodeURIComponent(v));
+    });
+  });
+
+  /*
+   * Adds a new nested assocation.  Depends on the nested association
+   * js templates being loaded.
+   */
+  $('a.add-nested-association').click(function(e) {
+    e.preventDefault();
+
+    var template;
+
+    // get the template for this attribute type
+    try { 
+      template = E9CRM.js_templates[this.getAttribute('data-association')];
+    } catch(e) { return }
+
+    // sub in the current index and increment it
+    template = template.replace(
+      new RegExp(E9CRM.js_templates.start_child_index, 'g'), 
+      ++E9A.js_templates.current_child_index
+    );
+
+    // and insert the new template before this link
+    $(template).insertBefore($(this));
+  });
+
+  /*
+   * Effectively destroys an added nested association, removing the container
+   * the association is not persisted, or hiding it and setting the _destroy
+   * parameter for the association if it is.
+   */
+  $('a.destroy-nested-association').live('click', function(e) {
+    e.preventDefault();
+
+    // grab the parent nested-association and attempt to get its hidden
+    // 'destroy' input if it exists.
+    var $parent = $(this).closest('.nested-association').hide(),
+        $destro = $parent.find('input[id$=__destroy]');
+
+    // If a in input ending in __destroy was found it means that this is a
+    // persisted record.  Set that input's value to '1' so it will be destroyed
+    // on record commit.
+    if ($destro.length) { $destro.val('1'); }
+
+    // otherwise this record was created locally and has not been saved, so
+    // simply remove it.
+    else { $parent.remove(); }
+  });
+});

data/lib/generators/e9_attributes/templates/migration.rb

@@ -0,0 +1,13 @@
+class CreateE9Attributes < ActiveRecord::Migration
+  def self.up
+    create_table :record_attributes, :force => true do |t|
+      t.string :type
+      t.references :record, :polymorphic => true
+      t.text :value, :options, :limit => 3.kilobytes
+    end
+  end
+
+  def self.down
+    drop_table :record_attributes
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: e9_attributes
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Travis Cox
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-19 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: |
+  E9 Attributes
+  =============
+  
+  Searchable attributes engine
+
+email: 
+- numbers1311407@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- app/controllers/e9_attributes/menu_options_controller.rb
+- app/models/menu_option.rb
+- app/models/record_attribute.rb
+- app/views/e9_attributes/menu_options/_form.html.haml
+- app/views/e9_attributes/menu_options/_table.html.haml
+- app/views/e9_attributes/menu_options/edit.html.haml
+- app/views/e9_attributes/menu_options/index.html.haml
+- app/views/e9_attributes/menu_options/index.js.erb
+- app/views/e9_attributes/menu_options/new.html.haml
+- app/views/e9_attributes/menu_options/show.html.haml
+- app/views/e9_attributes/record_attributes/_form_partial.html.haml
+- app/views/e9_attributes/record_attributes/_record_attribute.html.haml
+- app/views/e9_attributes/record_attributes/templates.js.erb
+- config/locales/en.yml
+- config/routes.rb
+- e9_attributes.gemspec
+- lib/e9_attributes.rb
+- lib/e9_attributes/helper.rb
+- lib/e9_attributes/model.rb
+- lib/e9_attributes/version.rb
+- lib/generators/e9_attributes/install_generator.rb
+- lib/generators/e9_attributes/templates/initializer.rb
+- lib/generators/e9_attributes/templates/javascript.js
+- lib/generators/e9_attributes/templates/migration.rb
+has_rdoc: true
+homepage: http://github.com/e9digital/e9_attributes
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: e9_attributes
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Searchable attributes
+test_files: []
+