xbrlware-extras 1.1.2.19.2 → 1.1.2.19.3

data/.gitignore

@@ -1,3 +1,4 @@
+*swp
 *.gem
 *.rbc
 .bundle

data/lib/xbrlware-extras/linkbase.rb

@@ -25,7 +25,10 @@ module Xbrlware
         end
 
         def is_disclosure?
-          @title.downcase =~ /^disclosure/ ? true : false
+          return true if @title.downcase =~ /^disclosure/ 
+          return true if @title.downcase =~ /^summary of/
+          return true if @title.downcase =~ /details$/
+          return false
         end
 
         def top_level_arcs
@@ -39,13 +42,34 @@ module Xbrlware
           return uniq_arcs
         end
 
-        def print_tree(indent_count=0)
+        def sort!(args)
+          @arcs = @arcs.sort do |x,y|
+            xscore = 0
+            yitems = y.leaf_items(args[:period])
+            x.leaf_items(args[:period]).each do |xnode|
+              yitems.each do |ynode|
+                xscore = (xnode <=> ynode) # NOTE: Assumes caller has defined <=> for all leaf nodes
+              end
+            end
+            puts "\"#{x.pretty_name}\" #{xscore <=> 0} \"#{y.pretty_name}\""
+            xscore <=> 0
+          end
+          @arcs.each{ |arc| arc.sort!(args) }
+        end
+
+        def sprint_tree(indent_count=0, simplified=false)
           indent = " " * indent_count
-          puts indent + "Calc: #{@title} (#{@role})"
+          output = indent + "Calc: #{@title} (#{@role})" + "\n"
 
-          @arcs.each { |arc| arc.print_tree(indent_count+1) }
+          #@arcs.each { |arc| output += arc.sprint_tree(indent_count+1, simplified) }
+          top_level_arcs.each { |arc| output += arc.sprint_tree(indent_count+1, simplified) }
 
-          puts indent + "\n\n"
+          output += indent + "\n\n"
+          output
+        end
+
+        def print_tree(indent_count=0, simplified=false)
+          puts sprint_tree(indent_count, simplified)
         end
 
         def leaf_items(period)
@@ -83,6 +107,23 @@ module Xbrlware
             end
           end
 
+          def sort!(args)
+            if @children
+              @children = @children.sort do |x,y|
+                xscore = 0
+                yitems = y.leaf_items(args[:period])
+                x.leaf_items(args[:period]).each do |xnode|
+                  yitems.each do |ynode|
+                    xscore = (xnode <=> ynode) # NOTE: Assumes caller has defined <=> for all leaf nodes
+                  end
+                end
+                puts "\"#{x.label}\" #{xscore <=> 0} \"#{y.label}\""
+                xscore <=> 0
+              end
+            end
+            (@children || []).each{ |child| child.sort!(args) }
+          end
+
           def contains_arc?(arc)
             return false if @children.empty?
 
@@ -94,19 +135,47 @@ module Xbrlware
             return false
           end
 
-          def print_tree(indent_count=0)
+          def sprint_tree(indent_count=0, simplified=false)
             indent = " " * indent_count
-            output = "#{indent} #{@label}"
-
-            (@items || []).each do |item|
-              period = item.context.period
-              period_str = period.is_duration? ? "#{period.value["start_date"]} to #{period.value["end_date"]}" : "#{period.value}"
-              output += " [#{item.def["xbrli:balance"]}]" if item.def
-              output += " (#{period_str}) = #{item.value}" if item.value
+            str = "#{indent} CA:#{@label}"
+
+            if simplified
+              (@items.last(1) || []).each do |item|
+                str += " I:{#{item.pretty_name}} "
+                # FIXME: First off, sub-leaf is terrible, non-standard, confusing terminology. Call it something else.
+                # FIXME: Second, why aren't we calling Item::print_tree()?
+                if item.is_sub_leaf?
+                  str += " [sub-leaf]"
+                else
+                  str += " [non-sub-leaf]"
+                end
+                period = item.context.period
+                period_str = period.is_duration? ? "#{period.value["start_date"]} to #{period.value["end_date"]}" : "#{period.value}"
+                str += " [#{item.def["xbrli:balance"]}]" if item.def && item.def["xbrli:balance"]
+                str += " (#{period_str}) = #{item.value}" if item.value
+              end
+            else
+              (@items || []).each do |item|
+                str += " I:{#{item.pretty_name}} "
+                if item.is_sub_leaf?
+                  str += " [sub-leaf]"
+                else
+                  str += " [non-sub-leaf]"
+                end
+                period = item.context.period
+                period_str = period.is_duration? ? "#{period.value["start_date"]} to #{period.value["end_date"]}" : "#{period.value}"
+                str += " [#{item.def["xbrli:balance"]}]" if item.def && item.def["xbrli:balance"]
+                str += " (#{period_str}) = #{item.value}" if item.value
+              end
             end
-            puts indent + output
+            output = indent + str + "\n"
+
+            (@children || []).each { |child| output += child.sprint_tree(indent_count+1, simplified) }
+            output
+          end
 
-            (@children || []).each { |child| child.print_tree(indent_count+1) }
+          def print_tree(indent_count=0, simplified=false)
+            puts sprint_tree(indent_count, simplified)
           end
 
           def leaf_items(period)
@@ -126,29 +195,39 @@ module Xbrlware
 
     class PresentationLinkbase
       class Presentation
-        def print_tree(indent_count=0)
+        def sprint_tree(indent_count=0, simplified=false)
           indent = " " * indent_count
-          puts indent + "Pres: #{@title} (#{@role})"
+          output = indent + "Pres: #{@title} (#{@role})" + "\n"
 
-          @arcs.each { |arc| arc.print_tree(indent_count+1) }
+          @arcs.each { |arc| output += arc.sprint_tree(indent_count+1, simplified) }
 
-          puts indent + "\n\n"
+          output += indent + "\n\n"
+          output
+        end
+
+        def print_tree(indent_count=0, simplified=false)
+          puts sprint_tree(indent_count, simplified)
         end
 
         class PresentationArc
-          def print_tree(indent_count=0)
+          def sprint_tree(indent_count=0, simplified=false)
             indent = " " * indent_count
-            output = "#{indent} #{@label}"
+            str = "#{indent} #{@label}"
 
             @items.each do |item|
               period=item.context.period
               period_str = period.is_duration? ? "#{period.value["start_date"]} to #{period.value["end_date"]}" : "#{period.value}"
-              output += " [#{item.def["xbrli:balance"]}]" unless item.def.nil?
-              output += " (#{period_str}) = #{item.value}" unless item.nil?
+              str += " [#{item.def["xbrli:balance"]}]" unless item.def.nil?
+              str += " (#{period_str}) = #{item.value}" unless item.nil?
             end
-            puts indent + output
+            output = indent + str + "\n"
+
+            @children.each { |child| output += child.sprint_tree(indent_count+1, simplified) }
+            output
+          end
 
-            @children.each { |child| child.print_tree(indent_count+1) }
+          def print_tree(indent_count=0, simplified=false)
+            puts sprint_tree(indent_count, simplified)
           end
         end
       end

data/lib/xbrlware-extras/version.rb

@@ -1,5 +1,5 @@
 module Xbrlware
   module Extras
-    VERSION = "1.1.2.19.2"
+    VERSION = "1.1.2.19.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xbrlware-extras
 version: !ruby/object:Gem::Version
-  version: 1.1.2.19.2
+  version: 1.1.2.19.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,23 +9,27 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-31 00:00:00.000000000 -04:00
-default_executable: 
+date: 2013-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xbrlware-ruby19
-  requirement: &79701520 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.1.2.19.2
   type: :runtime
   prerelease: false
-  version_requirements: *79701520
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.2.19.2
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &79701270 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,7 +37,12 @@ dependencies:
         version: 2.0.1
   type: :development
   prerelease: false
-  version_requirements: *79701270
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
 description: A set of extentions that make it easier to build on top of xbrlware
 email:
 - jim.lindstrom@gmail.com
@@ -56,7 +65,6 @@ files:
 - spec/spec_helper.rb
 - spec/xbrlware_helpers_spec.rb
 - xbrlware-extras.gemspec
-has_rdoc: true
 homepage: ''
 licenses: []
 post_install_message: 
@@ -77,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A set of extentions that make it easier to build on top of xbrlware