maiha-merb_inspector 0.1 → 0.2

data/Rakefile

@@ -4,12 +4,12 @@ require 'rake/gempackagetask'
 require 'merb-core'
 require 'merb-core/tasks/merb'
 
-GEM_NAME = "merb_inspector"
-GEM_VERSION = "0.0.1"
-AUTHOR = "Your Name"
-EMAIL = "Your Email"
-HOMEPAGE = "http://merbivore.com/"
-SUMMARY = "Merb plugin that provides ..."
+GEM_NAME    = "merb_inspector"
+GEM_VERSION = "0.2"
+AUTHOR      = "Maiha"
+EMAIL       = "maiha@wota.jp"
+HOMEPAGE    = "http://github.com/maiha/merb_inspector"
+SUMMARY     = "Merb plugin that provides powerful 'inspect' helper method"
 
 spec = Gem::Specification.new do |s|
   s.rubyforge_project = 'merb'
@@ -23,7 +23,7 @@ spec = Gem::Specification.new do |s|
   s.author = AUTHOR
   s.email = EMAIL
   s.homepage = HOMEPAGE
-  s.add_dependency('merb', '>= 1.0.6.1')
+  s.add_dependency('merb', '>= 1.0.7')
   s.require_path = 'lib'
   s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,spec}/**/*")
   

data/lib/merb_inspector/helper.rb

@@ -1,10 +1,19 @@
 module Merb
-  module Inspector
+  class Inspector
     module Helper
       def inspect(object = nil, options = {})
         return super() unless object
-        inspector = Merb::Inspector.lookup(object) || Merb::Inspector.default
-        inspector.new(object, self, options).execute
+
+        options = {:action=>options} if options.is_a?(Symbol)
+        action    = options[:action] || :show
+        inspector = (Manager.lookup(object) || Merb::Inspector.default).new(Merb::Request.new({}))
+
+        if inspector.respond_to?(action)
+          inspector.send action, object, options
+        else
+          message = "%s doesn't recognize '%s' action" % [inspector.class, action]
+          raise Merb::Inspector::ActionNotFound, message
+        end
       end
 
       def column_header(p)
@@ -19,7 +28,7 @@ module Merb
 
       def column_form(record, p)
         # first, search class prefixed method that user override
-        method = "#{record.class.name.demodulize}_#{p.name}_form"
+        method = "#{Extlib::Inflection.demodulize(record.class.name)}_#{p.name}_form"
         return send(method, record, p) if respond_to?(method, true)
 
         # second, search method that user override
@@ -27,29 +36,14 @@ module Merb
         return send(method, record, p) if respond_to?(method, true)
 
         # second, guess form from property type
-        if p.type == DataMapper::Types::Serial
+        if p.type == ::DataMapper::Types::Serial
           record.send p.name
-        elsif p.type == DataMapper::Types::Text
+        elsif p.type == ::DataMapper::Types::Text
           text_area p.name
         else
           text_field p.name
         end
       end
-
-      ######################################################################
-      ### Patch for broken merb methods
-
-      def xxx_form_for(name, attrs = {}, &blk)
-        if !attrs[:action] and defined?(DataMapper::Resource) and name.is_a?(DataMapper::Resource)
-          if name.new_record?
-            model  = name.class.name.demodulize.snake_case.pluralize.intern
-            attrs[:action] = resource(model, :new)
-          else
-            attrs[:action] = resource(name)
-          end
-        end
-        super(name, attrs, &blk)
-      end
     end
   end
 end

data/lib/merb_inspector/inspector.rb

@@ -1,87 +1,77 @@
 module Merb
-  # A convinient way to get at Merb::Cache
-  def self.inspector
-    Merb::Inspector
-  end
+  class Inspector < Application
+    ######################################################################
+    ### for exceptins
 
-  module Inspector
+    class Merb::Inspector::ActionNotFound < Merb::ControllerExceptions::ActionNotFound; end
+
+    ######################################################################
+    ### for module
 
     def self.root
-      @root ||= File.expand_path(File.dirname(__FILE__) + "/../../")
+      @root ||= Pathname(File.expand_path(File.dirname(__FILE__) + "/../../"))
     end
 
     def self.default
-      Merb::Inspectors::Base
+      Inspector
     end
 
-    class << self
-      attr_accessor :stores
-      attr_accessor :caches
+    def self.log(message)
+      path = Merb.root / "log" / "inspector.log"
+      message = "[Inspector] %s" % message.to_s.strip
+      File.open(path, "a+") {|f| f.puts message}
     end
 
-    self.stores = Hash.new
-    self.caches = Hash.new
-
-    def self.reset
-      @caches = Hash.new
+    def self.model(model, inspector = self)
+      Merb::Inspector::Manager.register(model, inspector)
     end
 
-    def self.register(klass, inspector)
-      raise "#{klass} inspector already setup" if @stores.has_key?(klass)
-      @stores[klass] = inspector
-      log "registered %s -> %s" % [klass, inspector]
+    ######################################################################
+    ### for class
+
+    def show(object, options = {})
+      @object  = object
+      @options = options
+
+      execute
     end
 
-    def self.lookup(object)
-      if @caches.has_key?(object.class)
-        log "lookup: %s => %s (cached)" % [object.class, @caches[object.class] || 'nil']
-        return @caches[object.class]
+    private
+      def name
+        self.class.name.sub(/^Merb::/,'').sub(/Inspector$/,'').snake_case.gsub(/::/, '/')
       end
-      klass = object.class.ancestors.find{|klass|
-        log "lookup:   %s = %s ... %s" % [object.class, klass, @stores[klass]]
-        @stores.has_key?(klass)
-      }
-      @caches[object.class] = @stores[klass]
-      if klass
-        log "lookup: %s => %s (registered)" % [object.class, @caches[object.class]]
-      else
-        log "lookup: %s => nil (registered as negative cache)" % [object.class]
+
+      def dir
+        Merb::Inspector.root + "templates" + name
       end
-      return @stores[klass]
-    end
 
-    def self.log(message)
-      path = Merb.root / "log" / "inspector.log"
-      message = "[Inspector] %s" % message.to_s.strip
-      File.open(path, "a+") {|f| f.puts message}
-    end
+      def template_for(name)
+        dir + name.to_s
+      end
 
-    ######################################################################
-    ### Install
+      def execute
+        partial template_for(template), current_options
+      end
 
-    def self.install
-      mirror("public/stylesheets")
-    end
+      def template
+        :default
+      end
 
-    def self.mirror(dir)
-      source_dir = File.join(File.dirname(__FILE__), '..', '..', 'mirror', dir)
-      target_dir = File.join(Merb.root, dir)
-      FileUtils.mkdir_p(target_dir) unless File.exist?(target_dir)
-
-      Dir[source_dir + "/*"].each do |src|
-        time = File.mtime(src)
-        file = File.basename(src)
-        dst  = File.join(target_dir, file)
-
-        next if File.directory?(src)
-        next if File.exist?(dst) and File.mtime(dst) >= time
-        FileUtils.copy(src, dst)
-        File.utime(time, time, dst)
-        command = File.exist?(dst) ? "update" : "install"
-        log "#{command}: #{dir}/#{file}"
+      def current_options
+        basic_options.merge(options)
       end
-    end
 
+      def options
+        {}
+      end
+
+      def basic_options
+        {:inspector=>self, :options=>@options, :dir=>dir, :id=>@object.object_id}
+      end
+  end
+
+  def self.inspector
+    Merb::Inspector
   end
 end
 

data/lib/merb_inspector/manager.rb

@@ -0,0 +1,76 @@
+module Merb
+  class Inspector
+    module Manager
+      ######################################################################
+      ### for module
+
+      class << self
+        attr_accessor :stores
+        attr_accessor :caches
+      end
+
+      self.stores = Hash.new
+      self.caches = Hash.new
+
+      def self.reset
+        self.caches = Hash.new
+      end
+
+      def self.register(klass, inspector)
+        raise "#{klass} inspector already setup" if stores.has_key?(klass)
+        stores[klass] = inspector
+        log "registered %s -> %s" % [klass, inspector]
+      end
+
+      def self.lookup(object)
+        if caches.has_key?(object.class)
+          log "lookup: %s => %s (cached)" % [object.class, caches[object.class] || 'nil']
+          return caches[object.class]
+        end
+        klass = object.class.ancestors.find{|klass|
+          log "lookup:   %s = %s ... %s" % [object.class, klass, stores[klass]]
+          stores.has_key?(klass)
+        }
+        caches[object.class] = stores[klass]
+        if klass
+          log "lookup: %s => %s (registered)" % [object.class, caches[object.class]]
+        else
+          log "lookup: %s => nil (registered as negative cache)" % [object.class]
+        end
+        return stores[klass]
+      end
+
+      def self.log(message)
+        path = Merb.root / "log" / "inspector.log"
+        message = "[Inspector] %s" % message.to_s.strip
+        File.open(path, "a+") {|f| f.puts message}
+      end
+
+      ######################################################################
+      ### Install
+
+      def self.install
+        mirror("public/stylesheets")
+      end
+
+      def self.mirror(dir)
+        source_dir = File.join(File.dirname(__FILE__), '..', '..', 'mirror', dir)
+        target_dir = File.join(Merb.root, dir)
+        FileUtils.mkdir_p(target_dir) unless File.exist?(target_dir)
+
+        Dir[source_dir + "/*"].each do |src|
+          time = File.mtime(src)
+          file = File.basename(src)
+          dst  = File.join(target_dir, file)
+
+          next if File.directory?(src)
+          next if File.exist?(dst) and File.mtime(dst) >= time
+          FileUtils.copy(src, dst)
+          File.utime(time, time, dst)
+          command = File.exist?(dst) ? "update" : "install"
+          log "#{command}: #{dir}/#{file}"
+        end
+      end
+    end
+  end
+end

data/lib/merb_inspector.rb

@@ -3,15 +3,6 @@ if defined?(Merb::Plugins)
 
   $: << File.dirname(__FILE__) unless $:.include?(File.dirname(__FILE__))
   
-  require "merb_inspector" / "inspector"
-  require "merb_inspector" / "helper"
-  require "merb_inspector" / "inspectors" / "base"
-  require "merb_inspector" / "inspectors" / "data_mapper" if defined?(DataMapper)
-
-  module Merb::GlobalHelpers
-    include Merb::Inspector::Helper
-  end
-
   # Merb gives you a Merb::Plugins.config hash...feel free to put your stuff in your piece of it
   Merb::Plugins.config[:merb_inspector] = {
     :chickens => false
@@ -19,10 +10,29 @@ if defined?(Merb::Plugins)
   
   Merb::BootLoader.before_app_loads do
     # require code that must be loaded before the application
-    Merb::Inspector.install
   end
   
   Merb::BootLoader.after_app_loads do
+    inspector_dir = File.dirname(__FILE__) / "../inspectors"
+
+    require "merb_inspector" / "inspector"
+    require "merb_inspector" / "manager"
+    require "merb_inspector" / "helper"
+
+    Dir["#{inspector_dir}/*.rb"].sort.each do |file|
+      begin
+        require file
+      rescue Exeption  => error
+        message = "[MerbInspector] load error: #{error} (#{error.class})"
+        Merb.logger.error message
+      end
+    end
+
+    class ::Application
+      include Merb::Inspector::Helper
+    end
+
+    Merb::Inspector::Manager.install
   end
   
   Merb::Plugins.add_rakefiles "merb_inspector/merbtasks"

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification 
 name: maiha-merb_inspector
 version: !ruby/object:Gem::Version 
-  version: "0.1"
+  version: "0.2"
 platform: ruby
 authors: 
-- maiha
+- Maiha
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-12-27 00:00:00 -08:00
+date: 2008-12-29 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: merb-core
+  name: merb
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -21,35 +21,29 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.0.7
     version: 
-description: ""
+description: Merb plugin that provides powerful 'inspect' helper method
 email: maiha@wota.jp
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
 files: 
 - LICENSE
 - README
 - Rakefile
 - TODO
-- lib/merb_inspector.rb
+- lib/merb_inspector
 - lib/merb_inspector/helper.rb
-- lib/merb_inspector/inspector.rb
-- lib/merb_inspector/inspectors/base.rb
-- lib/merb_inspector/inspectors/data_mapper.rb
 - lib/merb_inspector/merbtasks.rb
-- mirror/public/stylesheets/merb_inspector.css
-- spec/merb_inspector_spec.rb
+- lib/merb_inspector/manager.rb
+- lib/merb_inspector/inspector.rb
+- lib/merb_inspector.rb
 - spec/spec_helper.rb
-- templates/data_mapper/collection/_records.html.erb
-- templates/data_mapper/resource/_edit.html.erb
-- templates/data_mapper/resource/_new.html.erb
-- templates/data_mapper/resource/_record.html.erb
-- templates/data_mapper/resource/_show.html.erb
-- test/merb_inspector_test.rb
-- test/test_helper.rb
+- spec/merb_inspector_spec.rb
 has_rdoc: true
 homepage: http://github.com/maiha/merb_inspector
 post_install_message: 
@@ -71,10 +65,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: merb
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: ""
+summary: Merb plugin that provides powerful 'inspect' helper method
 test_files: []
 

data/lib/merb_inspector/inspectors/base.rb

@@ -1,60 +0,0 @@
-module Merb
-  module Inspectors
-    class Base
-      class << self
-        def register(klass)
-          Merb::Inspector.register(klass, self)
-        end
-      end
-
-      def initialize(object, caller, options = {})
-        @object  = object
-        @caller  = caller
-        @options = options
-        @options = {:action=>@options} unless @options.is_a?(Hash)
-#        @context = context || binding # not used yet
-      end
-
-      def execute
-        @object.inspect
-      end
-
-      private
-        def name
-          self.class.name.sub(/^Merb::Inspectors::/,'').sub(/Inspector$/,'').snake_case.gsub(/::/, '/')
-        end
-
-        def dir
-          File.join Merb::Inspector.root, "templates", name
-        end
-
-        def id
-          @object.object_id
-        end
-
-        def template_for(name)
-          File.join dir, name
-        end
-
-        def partial(name)
-          @caller.send :partial, template_for(name), current_options
-        end
-
-        def current_options
-          basic_options.merge(options)
-        end
-
-        def options
-          {}
-        end
-
-        def basic_options
-          {:inspector=>self, :options=>@options, :dir=>dir, :id=>id}
-        end
-
-        def method_missing(*args, &block)
-          @caller.send(*args, &block)
-        end
-    end
-  end
-end

data/lib/merb_inspector/inspectors/data_mapper.rb

@@ -1,103 +0,0 @@
-module Merb
-  module Inspectors
-    module DataMapper
-      module Resourceful
-        def resource_name
-          model.name.demodulize.plural.snake_case
-        end
-
-        def link_to_new(label = 'New', opts = {})
-          @caller.link_to label, @caller.resource(resource_name, :new), opts
-        rescue Merb::Router::GenerationError
-        end
-
-        def link_to_show(record = @object, label = 'Show', opts = {})
-          @caller.link_to label, @caller.resource(record), opts
-        rescue Merb::Router::GenerationError
-        end
-
-        def link_to_edit(record = @object, label = 'Edit', opts = {})
-          @caller.link_to label, @caller.resource(record, :edit), opts
-        rescue Merb::Router::GenerationError
-        end
-      end
-
-      class CollectionInspector < Base
-        register ::DataMapper::Collection
-        include  Resourceful
-
-        def execute
-          partial "records"
-        end
-
-        def columns
-          @object.properties
-        end
-
-        private
-          def model
-            @object.query.model
-          end
-
-          def options
-            {:model=>model, :records=>@object}
-          end
-      end
-
-      class ResourceInspector < Base
-        register ::DataMapper::Resource
-        include  Resourceful
-
-        def execute
-          partial template
-        end
-
-        def columns
-          model.properties
-        end
-
-        def edit_columns
-          columns.reject{|p| p.type == ::DataMapper::Types::Serial}
-        end
-
-        private
-          def id
-            oid = @object.new_record? ? "new" : @object.id
-            "#{resource_name}_#{oid}"
-          end
-
-          def model
-            @object.class
-          end
-
-          def template
-            if @options[:action].to_s == 'new'
-              "new"
-            else
-              "record"
-            end
-          end
-
-          def edit
-            %w( new edit ).include?(@options[:action].to_s)
-          end
-
-          def toggle
-            "$('##{id} .record').toggle();return false;"
-          end
-
-          def save_action
-            if @object.new_record?
-              "/" + resource_name
-            else
-              resource(@object)
-            end
-          end
-
-          def options
-            {:model=>model, :record=>@object, :edit=>edit, :save_action=>save_action, :toggle=>toggle}
-          end
-      end
-    end
-  end
-end

data/mirror/public/stylesheets/merb_inspector.css

@@ -1,87 +0,0 @@
-table.data-mapper-collection {
-border-collapse:collapse;
-}
-
-
-table.data-mapper-collection th {
-background-color: #555;
-text-align: left;
-}
-
-table.data-mapper-collection th a,
-table.data-mapper-collection th p {
-font: bold 11px arial, sans-serif;
-display: block;
-background-color: #555;
-}
-
-table.data-mapper-collection th a {
-color: #fff;
-padding: 2px 15px 2px 5px;
-}
-
-table.data-mapper-collection th p {
-color: #eee;
-padding: 2px 5px;
-}
-
-table.data-mapper-collection th a:hover {
-background-color: #000;
-color: #ff8;
-}
-
-table.data-mapper-collection > tbody > tr.record td {
-background-color: #E6F2FF;
-}
-
-table.data-mapper-collection > tbody > tr.record > td {
-padding: 5px 4px;
-color: #333;
-font-family: Verdana, sans-serif;
-font-size: 11px;
-border-bottom: solid 1px #C5DBF7;
-border-left: solid 1px #C5DBF7;
-}
-
-table.data-mapper-collection > tbody > tr.even-record td {
-background-color: #fff;
-}
-
-table.data-mapper-collection > tbody > tr.even-record > td {
-border-left: solid 1px #ddd;
-}
-
-table.data-mapper-collection > tbody >  tr.record > td.sorted {
-background-color: #B9DCFF;
-border-bottom: solid 1px #AFD0F5;
-}
-
-table.data-mapper-collection > tbody >  tr.even-record > td.sorted {
-background-color: #E6F2FF;
-border-bottom: solid 1px #AFD0F5;
-}
-
-
-
-.record table
-{
-        background-color: #fff;
-        border-collapse: collapse;
-        border-spacing: 0px;
-}
-.record table th
-{
-        background-color: #dee7ec;
-        border: 1px solid #8cacbb;
-        padding: 3px;
-}
-.record table td
-{
-        border: 1px solid #8cacbb;
-        padding: 3px;
-}
-
-table.logical th,
-table.logical td {
-        border: 0px;
-}

data/templates/data_mapper/collection/_records.html.erb

@@ -1,38 +0,0 @@
-<div>
-<table class="data-mapper-collection">
-  <thead>
-    <tr>
-<%- inspector.columns.each do |p| -%>
-      <th><p><%= column_header(p) %></p></th>
-<%- end -%>
-      <th></th>
-    </tr>
-  </thead>
-  <tbody class="records">
-<%- records.each_with_index do |record, i| -%>
-<%-
-tr_class = (i % 2 == 0) ? "even-record" : ""
-tr_class += " #{list_row_class(record)}" if respond_to? :list_row_class
--%>
-    <tr class="record <%=tr_class%>">
-<%- inspector.columns.each do |p| -%>
-      <td><%=h column_value(record, p) %></td>
-<%- end -%>
-      <td>
-        <table class="logical">
-          <tr>
-            <td><%= inspector.link_to_show(record) %></td>
-            <td><%= inspector.link_to_edit(record) %></td>
-            <td><%# delete_button(article, "Delete #{article.title}") %></td>
-          </tr>
-        </table>
-      </td>
-    </tr>
-<%- end -%>
-  </tbody>
-</table>
- 
-<%= inspector.link_to_new 'New' %>
-
-</div>
-

data/templates/data_mapper/resource/_edit.html.erb

@@ -1,15 +0,0 @@
-<div>
-<%= form_for record do %>
-<table class="record show">
-  <tbody>
-<%- columns.each do |p| -%>
-    <tr>
-      <th><%= column_header(p) %></th>
-      <td><%=h column_form(record, p) %></td>
-    </tr>
-<%- end -%>
-  </tbody>
-</table>
-<% end =%>
-</div>
-

data/templates/data_mapper/resource/_new.html.erb

@@ -1,24 +0,0 @@
-<div id="<%=id%>" style="display:block;">
-
-<div id="<%=id%>_edit" class="record edit" style="display:block;">
-<%= form_for record, :action=>save_action do %>
-<table>
-  <tbody>
-<%- inspector.columns.each do |p| -%>
-    <tr>
-      <th><%= column_header(p) %></th>
-      <td><%= column_form(record, p) %></td>
-    </tr>
-<%- end -%>
-    <tr>
-      <td colspan=2 align=center>
-        <%= submit "create".t %>
-        <%= link_to "cancel".t, "#", :onclick=>"$('##{id}').hide();return false;" %>
-      </td>
-    </tr>
-  </tbody>
-</table>
-<% end =%>
-</div>
-</div>
-

data/templates/data_mapper/resource/_record.html.erb

@@ -1,42 +0,0 @@
-<div id="<%=id%>">
-
-<div id="<%=id%>_show" class="record show" style="display:<%= edit ? 'none' : 'display' %>">
-<table>
-  <tbody>
-<%- inspector.columns.each do |p| -%>
-    <tr>
-      <th><%= column_header(p) %></th>
-      <td><%=h column_value(record, p) %></td>
-    </tr>
-<%- end -%>
-    <tr>
-      <td colspan=2 align=center>
-        <%= link_to "edit", "#", :onclick=>toggle %>
-      </td>
-    </tr>
-  </tbody>
-</table>
-</div>
-
-<div id="<%=id%>_edit" class="record edit" style="display:<%= edit ? 'display' : 'none' %>">
-<%= form_for record, :action=>save_action do %>
-<table>
-  <tbody>
-<%- inspector.columns.each do |p| -%>
-    <tr>
-      <th><%= column_header(p) %></th>
-      <td><%= column_form(record, p) %></td>
-    </tr>
-<%- end -%>
-    <tr>
-      <td colspan=2 align=center>
-        <%= submit (record.new_record? ? "create" : "update").t %>
-        <%= link_to "cancel", "#", :onclick=>toggle %>
-      </td>
-    </tr>
-  </tbody>
-</table>
-<% end =%>
-</div>
-</div>
-

data/templates/data_mapper/resource/_show.html.erb

@@ -1,13 +0,0 @@
-<div>
-<table class="record show">
-  <tbody>
-<%- columns.each do |p| -%>
-    <tr>
-      <th><%= column_header(p) %></th>
-      <td><%=h column_value(record, p) %></td>
-    </tr>
-<%- end -%>
-  </tbody>
-</table>
-</div>
-

data/test/test_helper.rb

@@ -1 +0,0 @@
-$:.push File.join(File.dirname(__FILE__), '..', 'lib')