maiha-active_record_view 0.1

data/README

@@ -0,0 +1,25 @@
+ActiveRecordView
+================
+
+# use :arv in controllers
+class ApplicationController < ActionController::Base
+  include ActiveRecordView::Controller
+end
+
+# use :arv in views
+module ApplicationHelper
+  include ActiveRecordView::Helper
+end
+
+
+Requirements
+============
+
+http://github.com/maiha/named_options
+
+
+Author
+======
+maiha@wota.jp
+
+

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the active_record_view plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the active_record_view plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActiveRecordView'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/arv/properties/boolean

@@ -0,0 +1,4 @@
+  :options :
+  :masters :
+    - true  : "Yes"
+    - false : "No"

data/arv/properties/date

@@ -0,0 +1,5 @@
+  :time_format : '%Y-%m-%d'
+  :options     :
+    :include_blank     : true
+    :use_month_numbers : true
+#    :start_year        : 2000

data/arv/properties/datetime

@@ -0,0 +1,5 @@
+  :time_format : '%Y-%m-%d'
+  :options     :
+    :include_blank     : true
+    :use_month_numbers : true
+#    :start_year        : 2000

data/arv/properties/default

@@ -0,0 +1,3 @@
+  :options :
+  :masters :
+#    - "value" : "Label"

data/arv/properties/integer

@@ -0,0 +1,6 @@
+#  :format  : "%s points"
+  :options :
+    :size   : 10
+  :masters :
+#    - 1  : "item1"
+#    - 2  : "item2"

data/arv/properties/string

@@ -0,0 +1,4 @@
+  :options :
+    :size   : 60
+  :masters :
+#  :format  : "%s"

data/arv/properties/text

@@ -0,0 +1,7 @@
+  :options :
+    :rows   : 5
+    :cols   : 60
+#  :column_type : :string
+  :ipe_options :
+    :rows   : 3
+    :cols   : 30

data/arv/properties/time

@@ -0,0 +1,5 @@
+  :time_format : '%Y-%m-%d'
+  :options     :
+    :include_blank     : true
+    :use_month_numbers : true
+#    :start_year        : 2000

data/arv/properties/timestamp

@@ -0,0 +1,5 @@
+  :time_format : '%Y-%m-%d'
+  :options     :
+    :include_blank     : true
+    :use_month_numbers : true
+#    :start_year        : 2000

data/arv/property.erb

@@ -0,0 +1,19 @@
+names:
+  :class    : "<%= klass.name %>"
+
+<%- maxlength = klass.columns.map{|column| column.name.length}.max -%>
+column_names:
+<%- for column in klass.columns -%>
+  <%= %Q|%-#{maxlength}s : "%s"| % [column.name, column.human_name] %>
+<%- end -%>
+
+<%- for column in klass.columns %>
+property_<%= column.name %>:
+<%- begin -%>
+<%= arv_file("properties/#{column.type}") -%>
+<%- rescue -%>
+<%= arv_file("properties/default") -%>
+<%- end -%>
+
+<%- end -%>
+

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/active_record_view.rb

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

data/lib/active_record_view/controller.rb

@@ -0,0 +1,9 @@
+module ActiveRecordView::Controller
+  include ActiveRecordView::RenderArv
+
+  def render_arv(arv, options = {})
+    add_variables_to_assigns
+    response.body = @template.render_arv(arv, options)
+    @performed_render = true
+  end
+end

data/lib/active_record_view/default_actions.rb

@@ -0,0 +1,29 @@
+module ActiveRecordView::DefaultActions
+  def link_to_new(record = nil)
+    link_to "追加", :action=>"new"
+  end
+
+  def link_to_list(record = nil)
+    link_to "一覧", :action=>"list"
+  end
+
+  def link_to_show(record)
+    link_to "参照", :action=>"show", :id=>record
+  end
+
+  def link_to_edit(record)
+    link_to "修正", :action=>"edit", :id=>record
+  end
+
+  def link_to_destroy(record)
+    link_to "削除", {:action=>"destroy", :id=>record}, :confirm=>"本当に削除しますか？", :method => "post"
+  end
+
+  def link_to_save(record)
+    if record.new_record?
+      link_to "作成", :action=>"create", :id=>record
+    else
+      link_to "更新", :action=>"update", :id=>record
+    end
+  end
+end

data/lib/active_record_view/engines.rb

@@ -0,0 +1,68 @@
+module ActiveRecordView
+  module Engines
+    extend RecordIdentifier
+
+    ######################################################################
+    ### Abstract Engine
+
+    class Base
+      include RecordIdentifier
+
+      def initialize(*args)
+        @method, @klass, @column, @view = args
+      end
+
+      def value(record, column = @column, view = @view)
+        record.__send__(column)
+      end
+
+      def show(record, column = @column, view = @view)
+        value(record, column, view)
+      end
+
+      def edit(record, column = @column, view = @view, record_name = nil)
+        record_name ||= singular_class_name(record.class)
+        tag_id   = "#{record_name}_#{column}"
+        tag_name = "#{record_name}[#{column}]"
+        view.text_field_tag tag_name, value(record, column, view), :name=>tag_name
+      end
+    end
+
+    ######################################################################
+    ### Concreate Engines
+
+    # helper methods should have first priority
+    class Helper < Base
+      def show(record, column = @column, view = @view)
+        view.__send__(@method, record)
+      end
+
+      def edit(record, column = @column, view = @view, record_name = nil)
+        view.__send__(@method, record)
+      end
+    end
+
+    # then we search view properties
+    class Property < Base
+      def show(record, column = @column, view = @view)
+        @method.human_value(super, view)
+      end
+
+      def edit(record, column = @column, view = @view, record_name = nil)
+        record_name ||= singular_class_name(record.class)
+        @method.human_edit(record_name, view, :record=>record)
+      end
+    end
+
+    # and then we try ducktyping by respond_to?
+    class DuckType < Base
+    end
+
+    # when no engines are found, we try to call record[key] as a last-effort
+    class Missing < Base
+      def value(record, column = @column, view = @view)
+        record[column]
+      end
+    end
+  end
+end

data/lib/active_record_view/helper.rb

@@ -0,0 +1,152 @@
+module ActiveRecordView::Helper
+  include ActiveRecordView::RecordIdentifier
+  include ActiveRecordView::WriteException
+  include ActiveRecordView::DefaultActions
+  include ActiveRecordView::RenderArv
+
+  def collection_tr_for(*args)
+    options = args.optionize :records, :fields
+    return nil if options[:records].blank?
+
+    if options[:fields].blank?
+      record = options[:records].first
+      record.is_a?(ActiveRecord::Base) or
+        raise TypeError, "expect ActiveRecord, but got #{record.class}"
+      options[:fields] = record.class.content_columns.map(&:name)
+    end
+
+    options[:records].map do |record|
+      style = list_row_class(record) if respond_to? :list_row_class
+      content_tag :tr,
+      options[:fields].map{|name|
+        html = active_record_value(record, name, :singular_name => options[:singular_name])
+        content_tag :td, html, :class=>name
+      }.join,
+      :class => [style, dom_class(record), options[:class] || options[:singular_name]].compact.join(' '),
+      :id    => dom_id(record, options[:prefix])
+    end.join
+  end
+
+  def collection_tbody_for(*args)
+    html = collection_tr_for(*args)
+    if html.blank?
+      return nil
+    else
+      content_tag(:tbody, html)
+    end
+  end
+
+  ######################################################################
+  ### ActiveRecord value
+  def active_record_value(record_or_name, format, options = {})
+    record = active_record_for(record_or_name)
+    engine = find_active_record_view_engine(record.class, format)
+    engine.show(record, format, self)
+  rescue NameError => err
+    write_exception(err)
+    record[format]
+  rescue Exception => err
+    active_record_error(err, record_or_name, format, options)
+  end
+
+  def active_record_form(record_or_name, format, options = {})
+    record_name = active_record_name_for(record_or_name)
+    record = options[:record] || active_record_for(record_or_name)
+    engine = find_active_record_view_engine(record.class, format, "edit_")
+    engine.edit(record, format, self, record_name)
+  rescue Exception => err
+    active_record_error(err, record_or_name, format, options)
+  end
+
+  def find_active_record_view_engine(klass, column, prefix = nil)
+    caching_key = [klass, column, prefix]
+    @cached_arv_engines ||= {}
+    @cached_arv_engines[caching_key] ||= active_record_view_engine_for(klass, column, prefix)
+  end
+
+  def active_record_error(err, record_or_name, format, options)
+    write_exception(err)
+    '???'
+  end
+
+  private
+    def active_record_for(record_or_name, strict = false)
+      record =
+        case record_or_name
+        when String, Symbol
+          instance_variable_get("@#{record_or_name}")
+        else
+          record_or_name
+        end
+      if strict and !record.is_a?(ActiveRecord::Base)
+        raise TypeError, "expect ActiveRecord, but got #{record.class} by #{record_or_name.inspect}"
+      end
+      return record
+    end
+
+    ######################################################################
+    ### Engine mapper
+
+    def active_record_view_engine_for(klass, column, prefix = nil)
+      ActiveRecord::Base.logger.debug "active_record_view: searching renderer for (%s, %s)" % [klass, column]
+      column = column.to_s.intern
+      active_record_view_engine_for_active_record(klass, column, self, prefix) or
+        active_record_view_engine_for_classed_helper(klass, column, self) or
+        active_record_view_engine_for_helper(klass, column, self) or
+        active_record_view_engine_for_ducktype(klass, column, self) or
+        active_record_view_engine_for_missing(klass, column, self) or
+        raise TypeError, "no engines found for #{klass}"
+    end
+
+    def active_record_view_engine_for_classed_helper(klass, column, view)
+      method = "%s_%s" % [active_record_name_for(klass), column]
+      view.respond_to?(method) and
+        ActiveRecordView::Engines::Helper.new(method, klass, column, view)
+    end
+
+    def active_record_view_engine_for_helper(klass, column, view)
+      view.respond_to?(column) and
+        ActiveRecordView::Engines::Helper.new(column, klass, column, view)
+    end
+
+    def active_record_view_engine_for_ducktype(klass, column, view)
+      klass.new.respond_to?(column) and
+        ActiveRecordView::Engines::DuckType.new(column, klass, column, view)
+    rescue ArgumentError
+      klass.instance_methods.include?(column.to_s) and
+        ActiveRecordView::Engines::DuckType.new(column, klass, column, view)
+    end
+
+    def active_record_view_engine_for_missing(klass, column, view)
+      klass.instance_methods.include?("[]") and
+        ActiveRecordView::Engines::Missing.new(column, klass, column, view)
+    end
+
+    def active_record_view_engine_for_active_record(klass, column, view, prefix)
+      index = klass.ancestors.index(ActiveRecord::Base) or return nil
+      ancestors = [klass] + klass.ancestors[0...index]
+      checked_methods = {}
+      ancestors.each do |k|
+        helper_method = ("%s%s_%s" % [prefix, active_record_name_for(k), column]).intern
+        next if checked_methods[helper_method]
+        checked_methods[helper_method] = true
+
+        # first, check helper methods
+        exist = respond_to?(helper_method)
+        ActiveRecord::Base.logger.debug "  helper method '#{helper_method}' ... %s" % (exist ? "yes" : "no")
+        return ActiveRecordView::Engines::Helper.new(helper_method, klass, column, view) if exist
+
+        # second, check view property if not STI
+        next unless k.is_a?(Class)
+        next unless k.descends_from_active_record?
+
+        property = Localized::ViewProperty[k, column]
+        if property and !property.blank?
+          ActiveRecord::Base.logger.debug "  ViewProperty[%s, %s] ... yes" % [k, column]
+          return ActiveRecordView::Engines::Property.new(property, klass, column, view)
+        end
+      end
+      return nil
+    end
+
+end

data/lib/active_record_view/record_identifier.rb

@@ -0,0 +1,42 @@
+module ActiveRecordView::RecordIdentifier
+  # derived from SimplyHelpful::RecordIdentifier
+    def partial_path(record_or_class)
+      klass = class_from_record_or_class(record_or_class)
+      "#{klass.name.tableize}/#{klass.name.demodulize.underscore}"
+    end
+
+    def dom_class(record_or_class, prefix = nil)
+      [ prefix, singular_class_name(record_or_class) ].compact * '_'
+    end
+
+    def dom_id(record, prefix = nil)
+      prefix ||= 'new' unless record.id
+      [ prefix, singular_class_name(record), record.id ].compact * '_'
+    end
+
+    def plural_class_name(record_or_class)
+      singular_class_name(record_or_class).pluralize
+    end
+
+    def singular_class_name(record_or_class)
+      class_from_record_or_class(record_or_class).name.underscore.tr('/', '_')
+    end
+
+    def demodulized_class_name(record_or_class)
+      class_from_record_or_class(record_or_class).name.demodulize.underscore.tr('/', '_')
+    end
+
+    def active_record_name_for(name)
+      case name
+      when String, Symbol
+        name.to_s
+      else
+        demodulized_class_name(name)
+      end
+    end
+
+    private
+      def class_from_record_or_class(record_or_class)
+        record_or_class.is_a?(Class) ? record_or_class : record_or_class.class
+      end
+end