mattock 0.2.0 → 0.2.1

data/lib/mattock/yard_extensions.rb

@@ -0,0 +1,126 @@
+require 'yard'
+YARD::Templates::Engine.register_template_path File::expand_path("../../../yard_templates", __FILE__)
+
+module Mattock
+  module YARDExtensions
+    class SettingHandler < YARD::Handlers::Ruby::Base
+      include YARD::Parser::Ruby
+
+      handles method_call(:setting)
+      namespace_only
+
+      def extract_name(obj)
+        case obj.type
+        when :symbol_literal
+          obj.jump(:ident, :op, :kw, :const)[0]
+        when :string_literal
+          obj.jump(:tstring_content)[0]
+        else
+          raise YARD::Parser::UndocumentableError, obj.source
+        end
+      end
+
+      def append_name(sexp, name)
+        prefix = sexp.jump(:ident, :string_content)
+        if prefix == sexp
+          raise YARD::Parser::UndocumentableError, sexp.source
+        end
+
+        "#{prefix[0]}.#{name}"
+      end
+
+      def synthetic_setting(name, value=nil)
+        args = s( s(:string_literal, s(:string_content, s(:tstring_content, name))))
+        args << value unless value.nil?
+        args << false
+        new_call = s(:fcall, s(:ident, "setting"), s(:arg_paren, args))
+        new_call.line_range = (1..1)
+        new_call.traverse do |node|
+          node.full_source ||= ""
+        end
+        new_call.full_source = "setting('#{name}'#{value.nil? ? "" : ", #{value.source}"})"
+        new_call
+
+      end
+
+      def process
+        #filter further based on NS === Configurable...
+        name = extract_name(statement.parameters.first)
+
+        value = statement.parameters(false)[1]
+        if !value.nil? and value.type == :fcall and value.jump(:ident)[0] == "nested"
+          remapped = value.parameters(false).first.map do |assoc|
+            new_name =
+                append_name(statement.parameters[0], extract_name(assoc[0]))
+            synthetic_setting(new_name, assoc[1])
+          end
+          parser.process(remapped)
+          return
+        end
+
+        setting = YARD::CodeObjects::MethodObject.new(namespace, name) do |set|
+          unless value.nil?
+            set['default_value'] = statement.parameters(false)[1].source
+          end
+          set.signature = "def #{name}"
+          if statement.comments.to_s.empty?
+            set.docstring = "The value of setting #{name}"
+          else
+            set.docstring = statement.comments
+          end
+
+          set.dynamic = true
+        end
+
+        register setting
+        (namespace[:settings] ||= []) << setting
+      end
+    end
+
+    class SettingsHandler < SettingHandler
+      handles method_call(:settings)
+      namespace_only
+
+      def process
+        remapped = statement.parameters(false).first.map do |assoc|
+          new_name =
+            append_name(statement.parameters[0], extract_name(assoc[0]))
+          synthetic_setting(new_name, assoc[1])
+        end
+        parser.process(remapped)
+      end
+    end
+
+    class NilFieldsHandler < SettingHandler
+      handles method_call(:nil_field)
+      handles method_call(:nil_fields)
+      namespace_only
+
+      def a_nil
+        v = s(:kw, nil)
+        v.full_source = "nil"
+        v
+      end
+
+      def process
+        remapped = statement.parameters(false).map do |name|
+          synthetic_setting(extract_name(name), a_nil)
+        end
+        parser.process(remapped)
+      end
+    end
+
+    class RequiredFieldsHandler < SettingHandler
+      handles method_call(:required_field)
+      handles method_call(:required_fields)
+      namespace_only
+
+      def process
+        remapped = statement.parameters(false).map do |name|
+          synthetic_setting(extract_name(name))
+        end
+        parser.process(remapped)
+      end
+    end
+  end
+end

data/spec/template-host.rb

@@ -0,0 +1,17 @@
+require 'mattock'
+
+describe Mattock::TemplateHost do
+  let :template_host do
+    Object.new.tap do |host|
+      host.extend Mattock::TemplateHost
+      def host.test_value; "A test value"; end
+    end
+  end
+
+  it "should be able to do easy templating" do
+    template_host.valise = Mattock::ValiseManager.default_valise("spec_help")
+    template_host.render("test.erb").should == "Templated: A test value\n"
+
+  end
+
+end

data/spec/yard-extensions.rb

@@ -0,0 +1 @@
+require 'mattock/yard_extensions'

data/yard_templates/default/module/html/setting_summary.erb

@@ -0,0 +1,35 @@
+<li class="<%= @item.visibility %> <%= @item.has_tag?(:deprecated) ? 'deprecated' : '' %>">
+  <span class="summary_signature">
+    <% if @item.tags(:overload).size == 1 %>
+      <%= signature(@item.tag(:overload), true, !@item.attr_info) %>
+    <% else %>
+      <%= signature(@item, true, false, !@item.attr_info) %>
+    <% end %>
+
+    <% if @item.aliases.size > 0 %>
+      (also: <%= @item.aliases.map {|o| h(o.name(true)) }.join(", ") %>)
+    <% end %>
+  </span>
+  <% if @item.constructor? %>
+    <span class="note title constructor">constructor</span>
+  <% end %>
+  <% if rw = @item.attr_info %>
+    <% if rw[:read] && !rw[:write] %><span class="note title readonly">readonly</span><% end %>
+    <% if rw[:write] && !rw[:read] %><span class="note title writeonly">writeonly</span><% end %>
+  <% end %>
+  <% if @item.visibility != :public %><span class="note title <%= @item.visibility %>"><%= @item.visibility %></span><% end %>
+  <% if @item.has_tag?(:abstract) %><span class="abstract note title">Abstract</span><% end %>
+  <% if @item.has_tag?(:deprecated) %><span class="deprecated note title">Deprecated</span><% end %>
+  <% if @item.has_tag?(:api) && @item.tag(:api).text == 'private' %><span class="private note title">Private</span><% end %>
+
+  <% if @item.has_tag?(:deprecated) %>
+    <span class="summary_desc"><strong>Deprecated.</strong> <%= htmlify_line @item.tag(:deprecated).text %></span>
+  <% else %>
+    <span class="summary_desc"><%= htmlify_line docstring_summary(@item) %></span>
+  <% end %>
+  <% if !@item["default_value"] %>
+    <span class="summary_desc"><em>This setting must have a value set</em></span>
+  <%else%>
+    <span class="summary_desc">Default value: <code><%= @item["default_value"] %></code></span>
+  <%end%>
+</li>

data/yard_templates/default/module/html/settings.erb

@@ -0,0 +1,8 @@
+<% groups(object[:settings] || [], "Settings") do |list, name| %>
+  <h2><%= name %> <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+  <ul class="summary">
+    <% list.each do |meth| %>
+      <%= yieldall :item => meth %>
+    <% end %>
+  </ul>
+<% end %>

data/yard_templates/default/module/setup.rb

@@ -0,0 +1,15 @@
+def init
+  super
+  sections.place(:settings, [:setting_summary]).before(:attribute_summary)
+end
+
+def prune_method_listing(list, hide_attrs=true)
+  list = super
+  list.reject do |o|
+    unless CodeObjects::Proxy === o.namespace or o.namespace[:settings].nil?
+      o.namespace[:settings].include?(o)
+    else
+      false
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: mattock
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Judson Lester
@@ -110,12 +110,16 @@ extra_rdoc_files:
 - doc/coverage/assets/0.5.3/loading.gif
 - doc/coverage/assets/0.5.3/jquery-1.6.2.min.js
 files: 
+- yard_templates/default/module/setup.rb
+- yard_templates/default/module/html/setting_summary.erb
+- yard_templates/default/module/html/settings.erb
 - lib/mattock/command-line.rb
 - lib/mattock/command-task.rb
 - lib/mattock/testing/rake-example-group.rb
 - lib/mattock/testing/mock-command-line.rb
 - lib/mattock/testing/record-commands.rb
 - lib/mattock/template-host.rb
+- lib/mattock/yard_extensions.rb
 - lib/mattock/remote-command-task.rb
 - lib/mattock/tasklib.rb
 - lib/mattock/task.rb
@@ -128,6 +132,8 @@ files:
 - spec/command-task.rb
 - spec/tasklib.rb
 - spec/configurable.rb
+- spec/yard-extensions.rb
+- spec/template-host.rb
 - spec_help/spec_helper.rb
 - spec_help/gem_test_suite.rb
 - doc/coverage/index.html
@@ -189,7 +195,7 @@ rdoc_options:
 - --main
 - doc/README
 - --title
-- mattock-0.2.0 RDoc
+- mattock-0.2.1 RDoc
 require_paths: 
 - lib/
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -197,7 +203,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1033845645
+      hash: 697578897
       segments: 
       - 0
       version: "0"