xbrlware-ce 1.1.0 → 1.1.1

data/example/callb/calculation_elements_to_table.rb

@@ -0,0 +1,62 @@
+require 'xbrlware'
+
+## Assuming you have table "calculations" with below structure
+# id
+# element_name
+# element_value
+# element_label
+# period_start_date
+# period_end_date
+# parent_id
+
+def format_timeline(timeline) ## date format function
+  return Xbrlware::DateUtil.stringify_date(timeline.value) unless timeline.is_duration?
+  header = StringIO.new
+  header << Xbrlware::DateUtil.stringify_date(timeline.value["end_date"]) << " : "
+  header << Xbrlware::DateUtil.months_between(timeline.value["start_date"], timeline.value["end_date"]).to_s
+  header << " months ( from " << Xbrlware::DateUtil.stringify_date(timeline.value["start_date"]) << ")"
+  header.string
+end
+
+def to_table(cal_elements, timeline, parent=nil)
+  cal_elements.each do |element|
+
+    id="table_unique_id_or_primary_key" # replace this with db unique-id.
+    p_element_id=id if parent.nil?
+    p_element_id=parent unless parent.nil?
+
+    matched_item=element.items.select {|item| timeline.to_s==item.context.period.to_s}[0]
+
+    unless matched_item.nil?
+      ### to calculation table
+
+      element_label = element.label
+      element_name=matched_item.name
+      element_value=matched_item.value
+
+      period = matched_item.context.period
+      period_start_date, period_end_date = period.value["start_date"], period.value["end_date"] if period.is_duration?
+      period_start_date, period_end_date = period.value, period.value if period.is_instant?
+      period_start_date, period_end_date = nil, nil if period.is_forever?
+      
+      parent_id  = p_element_id
+
+      # Insert to table
+    end
+    to_table(element.children, timeline, id) if element.has_children?
+  end
+end
+
+ins=Xbrlware.ins("/data/764180/000119312510039027/mo-20091231.xml") # change this with actual instance files
+cals=ins.taxonomy.callb.calculation
+
+cals.each do |cal|
+  puts"\n\n Start ::: Calculation -- #{cal.title} \n\n"
+  cal.timelines.each do |timeline|
+    puts"#{format_timeline(timeline)}"
+    to_table(cal.arcs, timeline)
+    puts "\n"
+  end
+  puts" End ::: Calculation -- #{cal.title}"
+  puts "=" * 80
+end

data/example/case_study/cash_analyzer.rb

@@ -0,0 +1,27 @@
+require 'edgar'
+require 'xbrlware'
+
+d=Edgar::HTMLFeedDownloader.new
+url="http://www.sec.gov/Archives/edgar/data/1281761/000119312510036446/0001193125-10-036446-index.htm"
+download_dir=url.split("/")[-2] # download dir is : 000119312510036446
+d.download(url, download_dir)
+
+ins=Xbrlware.ins(Xbrlware.file_grep(download_dir)["ins"])
+fye=ins.entity_details["fiscal_end_date"]
+
+data={}
+[2009, 2008].each do |year|
+  end_date=Date.parse(fye.gsub(/--/, "#{year}-"))
+  items=ins.item_ctx_filter("CashAndCashEquivalentsAtCarryingValue") do |ctx|
+    day_diff=(ctx.period.value-end_date).to_i
+    ctx.period.is_instant? && (day_diff==0 || day_diff==1)
+  end
+  data[year]=items[0]
+end
+
+cash_2008=data[2008].value
+cash_2009=data[2009].value
+
+puts "Percentage increase/decrease in cash value 2008-2009 is === #{((cash_2009.to_f-cash_2008.to_f)/cash_2008.to_f) * 100}"
+
+

data/lib/edgar/edgar_data_downloader.rb

@@ -45,8 +45,8 @@ module Edgar
         data_dir=data_dir+File::SEPARATOR+item["xbrlFiling"][0]["accessionNumber"][0]["content"]
         mkdir(data_dir)
         files.each do |file|
-          file_content=open(file["url"]).read
-          dump_to_file(data_dir+File::SEPARATOR+file["file"], file_content)
+          file_content=open(file["edgar:url"]).read
+          dump_to_file(data_dir+File::SEPARATOR+file["edgar:file"], file_content)
         end
       end
     end
@@ -60,9 +60,9 @@ module Edgar
         files=get_xbrl_files(item)
         files.each do |file|
           if file["type"]=="EX-101.INS" && (i_size==0 || file["size"].to_i < i_size)
-            i_size = file["size"].to_i
-            i_url = file["url"]
-            title = item["title"]
+            i_size = file["edgar:size"].to_i
+            i_url = file["edgar:url"]
+            title = item["edgar:title"]
           end
         end
       end
@@ -74,7 +74,7 @@ module Edgar
     # Gets url that end with xml and xsd 
     def get_xbrl_files(item)
       xbrl_files=item["xbrlFiling"][0]["xbrlFiles"][0]["xbrlFile"]
-      return xbrl_files.select {|e| e["url"].end_with?("xml") || e["url"].end_with?("xsd")}
+      return xbrl_files.select {|e| e["edgar:url"].end_with?("xml") || e["edgar:url"].end_with?("xsd")}
     end
 
   end

data/lib/xbrlware.rb

@@ -28,6 +28,7 @@ require 'set'
 require "stringio"
 require 'cgi'
 
+require 'xbrlware/version'
 require 'xbrlware/float_patch'
 require 'xbrlware/cgi_patch'
 require 'xbrlware/meta_util'
@@ -41,6 +42,7 @@ require 'xbrlware/util'
 require 'xbrlware/taxonomies/us_gaap_taxonomy_20090131'
 require 'xbrlware/taxonomy'
 
+require 'xbrlware/ns_aware'
 require 'xbrlware/context'
 require 'xbrlware/instance'
 require 'xbrlware/unit'

data/lib/xbrlware/context.rb

@@ -21,6 +21,8 @@ module Xbrlware
   # This class represents each context in the XBRL instance file.
   # Look at {delaing with instance page on xbrlware wiki}[http://code.google.com/p/xbrlware/wiki/InstanceTaxonomy] for more details.
   class Context
+    include NSAware
+    
     attr_reader :id, :entity, :period, :scenario
     PERIOD_FOREVER = -1
 

data/lib/xbrlware/instance.rb

@@ -28,7 +28,7 @@ module Xbrlware
 
     # Creates an Instance.
     #
-    # instance_filepath:: XBRL Instance source. Tries to load and parse instance file from the path.
+    # instance_str:: XBRL Instance source. Tries to load and parse instance file from the instance_str. This can be XBRL instance file from the file system or XBRL content string.
     #
     # taxonomy_filepath::
     #   optional parameter, XBRL Taxonomy source. Tries to load and parse taxonomy file from path.
@@ -39,21 +39,28 @@ module Xbrlware
     # which will cause parsing error. Hence any exceptions during instance source parsing, will trigger re-parsing of
     # the entire instnace file with new lines replaced.
     # Look at {delaing with instance page on xbrlware wiki}[http://code.google.com/p/xbrlware/wiki/InstanceTaxonomy] for details.
-    def initialize(instance_filepath, taxonomy_filepath=nil)
+    def initialize(instance_str, taxonomy_filepath=nil)
       m=Benchmark.measure do
         begin
-          @file_name=instance_filepath
-          @xbrl_content = XmlParser.xml_in(instance_filepath, {'ForceContent' => true})
+          @file_name=instance_str unless instance_str =~ /<.*?>/m
+          @xbrl_content = XmlParser.xml_in(instance_str, {'ForceContent' => true})
         rescue Exception
-          $LOG.warn "File ["+instance_filepath+"] is not well formed. Starting reparsing after removing new lines."
-          @xbrl_content = XmlParser.xml_in(File.open(instance_filepath).read.gsub("\n", ""), {'ForceContent' => true})
+          new_content=nil
+          if instance_str =~ /<.*?>/m
+            $LOG.warn "Supplied XBRL content is not well formed. Starting reparsing after removing new lines."
+            new_content=instance_str.gsub("\n", "")
+          else
+            $LOG.warn "File ["+instance_str+"] is not well formed. Starting reparsing after removing new lines."
+            new_content=File.open(instance_str).read.gsub("\n", "")
+          end
+          @xbrl_content = XmlParser.xml_in(new_content, {'ForceContent' => true}) unless new_content.nil?
         end
       end
-      bm("Parsing [" + instance_filepath + "] took", m)
+      bm("Parsing [" + instance_str + "] took", m)
 
       # if taxonomy file is not supplied, get it from instance schema_ref
       if taxonomy_filepath.nil?
-        taxonomy_file_location=File.dirname(instance_filepath)+File::Separator+schema_ref
+        taxonomy_file_location=File.dirname(instance_str)+File::Separator+schema_ref
         taxonomy_filepath = taxonomy_file_location if File.exist?(taxonomy_file_location) && (not File.directory?(taxonomy_file_location))
       end
 
@@ -131,8 +138,8 @@ module Xbrlware
       all_contexts= context(nil, dimensions)
       all_contexts=[all_contexts] unless all_contexts.is_a?(Array)
       all_contexts.each do |ctx|
-        period_group[ctx.period.to_s] = [] if period_group[ctx.period.to_s].nil?
-        period_group[ctx.period.to_s] << ctx
+        period_group[ctx.period] = [] if period_group[ctx.period].nil?
+        period_group[ctx.period] << ctx
       end
       period_group
     end
@@ -152,6 +159,10 @@ module Xbrlware
       end
     end
 
+    def inspect
+      self.to_s
+    end
+
     private
     # Takes optional context_id
     #   Returns all contexts if context_id is nil
@@ -183,7 +194,10 @@ module Xbrlware
       p = period(period_content)
 
       s = scenario(ctx_content)
-      return Context.new(id, e, p, s)
+      _context = Context.new(id, e, p, s)
+      _context.ns=ctx_content["nspace"]
+      _context.nsp=ctx_content["nspace_prefix"]
+      return _context
     end
 
     # Returns map  if period is duration. Map has key with name "start_date" and "end_date" 
@@ -237,8 +251,9 @@ module Xbrlware
 
         next unless unit_id.nil? || unit["id"].to_s == unit_id
 
+        _unit=nil
         unless unit["measure"].nil?
-          units << Unit.new(unit["id"], l.call(unit["measure"]))
+          _unit = Unit.new(unit["id"], l.call(unit["measure"]))
         else
           divide_content = unit["divide"][0]
 
@@ -246,8 +261,11 @@ module Xbrlware
           denominator = l.call(divide_content["unitDenominator"][0]["measure"])
 
           divide=Unit::Divide.new(numerator, denominator)
-          units << Unit.new(unit["id"], divide)
+          _unit = Unit.new(unit["id"], divide)
         end
+        _unit.ns=unit["nspace"]
+        _unit.nsp=unit["nspace_prefix"]
+        units << _unit
       end
       return units[0] unless unit_id.nil?
       units
@@ -265,22 +283,41 @@ module Xbrlware
       decimals = item["decimals"] unless item["decimals"].nil?
 
       _footnotes = footnotes(item["id"]) unless item["id"].nil?
-      item=Item.new(name, context, value, unit, precision, decimals, _footnotes)
-      item.def=@taxonomy.definition(name)
-      return item
+      _item=Item.new(self, name, context, value, unit, precision, decimals, _footnotes)
+      _item.ns=item["nspace"]
+      _item.nsp=item["nspace_prefix"]
+      _item.def=@taxonomy.definition(name)
+      return _item
     end
 
     public
-    def item_all_map
+    def item_all
+
+      return @item_all unless @item_all.nil?
+
       all_items = @xbrl_content
       return nil if all_items.nil?
 
-      items_hash={}
+      @item_all=[]
 
       all_items.each do |name, item_content|
-        _name=name.upcase
-        next if _name=="CONTEXT" || _name=="UNIT"
-        items_hash[name.upcase] = item(name)
+        next unless item_content.is_a?(Array)
+        next if item_content.size > 0 && item_content[0]["contextRef"].nil?
+        @item_all = @item_all + item(name)
+      end
+      @item_all
+    end
+
+    def item_all_map
+      items=item_all
+      return nil if items.nil?
+
+      items_hash={}
+
+      items.each do |item|
+        _name= item.name.upcase
+        items_hash[_name] = [] unless items_hash.include?(_name)
+        items_hash[_name] << item
       end
       items_hash
     end
@@ -292,7 +329,7 @@ module Xbrlware
 
       item_content = @xbrl_content[name]
 
-      return nil if item_content.nil?
+      return [] if item_content.nil?
 
       items=[]
 
@@ -375,11 +412,13 @@ module Xbrlware
           @entity_details["fiscal_end_date"]=e_fiscal_end_date.value unless e_fiscal_end_date.nil?
           @entity_details["common_shares_outstanding"]=e_common_shares_outstanding.value unless e_common_shares_outstanding.nil?
 
-          file_name=File.basename(@file_name)
-          symbol=file_name.split("-")[0]
-          symbol.upcase!
+          unless @file_name.nil?
+            file_name=File.basename(@file_name)
+            symbol=file_name.split("-")[0]
+            symbol.upcase!
 
-          @entity_details["symbol"]=symbol unless symbol.nil?
+            @entity_details["symbol"]=symbol unless symbol.nil?
+          end
         rescue Exception => e
           @entity_details
         end

data/lib/xbrlware/item.rb

@@ -23,12 +23,15 @@ module Xbrlware
   #  Taxonomy definition of a item can be retrieved using def or meta methods.
   # Look at {delaing with instance page on xbrlware wiki}[http://code.google.com/p/xbrlware/wiki/InstanceTaxonomy] for more details.
   class Item
-    attr_reader :name, :context,:unit,:precision,:decimals, :footnotes
-    attr_accessor :def
+    include NSAware
+
+    attr_reader :name, :context, :unit, :precision, :decimals, :footnotes
+    attr_accessor :ins, :def
 
     # Constructs item
     # value is normalized based on precision and decimals passed as per XBRL specification
-    def initialize(name, context, value, unit=nil,precision=nil,decimals=nil, footnotes=nil)
+    def initialize(instance, name, context, value, unit=nil, precision=nil, decimals=nil, footnotes=nil)
+      @ins=instance
       @name=name
       @context = context
       @precision=precision
@@ -39,10 +42,14 @@ module Xbrlware
     end
 
     def value
-      return yield(@value) if block_given?      
+      return yield(@value) if block_given?
       @value
     end
-    
+
+    def is_value_numeric?
+      @value.to_i.to_s == @value || @value.to_f.to_s == @value
+    end
+
     alias_method :meta, :def
 
     def balance
@@ -51,40 +58,40 @@ module Xbrlware
     end
 
     class ItemValue # :nodoc:
-      
+
       attr_reader  :item_value
-      
-      def initialize(item_value,precision=nil,decimals=nil)
+
+      def initialize(item_value, precision=nil, decimals=nil)
         @item_value=item_value
         @precision=precision
         @decimals=decimals
       end
 
       def value()
-        return precision() unless @precision.nil?  
+        return precision() unless @precision.nil?
         return decimals() unless @decimals.nil?
         return @item_value
       end
-      
+
       # returns BigDecimal float representation as String
       def precision()
         return @item_value if @precision=="INF"
-        
+
         precision_i=@precision.to_i
         new_value=BigDecimal(@item_value)
-        
+
         is_value_integer = new_value==@item_value.to_i
-        
-        
-        return to_precision_from_integer(@item_value.to_i, precision_i) if is_value_integer 
-        
+
+
+        return to_precision_from_integer(@item_value.to_i, precision_i) if is_value_integer
+
         index_of_dot = new_value.abs.to_s("F").index(".")
-        
+
         # When mod value is greater than 1 and float number 
         if new_value.abs > 1
           #Precision is less than number of digits before decimal
           return to_precision_from_integer(new_value.to_i, precision_i) if precision_i <= index_of_dot
-          
+
           #Precision is greater than number of digits before decimal
           return new_value.round(precision_i-index_of_dot).to_s("F")
         else
@@ -93,23 +100,24 @@ module Xbrlware
           return new_value.round(no_of_zeroes + precision_i).to_s("F")
         end
       end
-      
+
       # returns BigDecimal float representation as String
       def decimals
-        return BigDecimal(@item_value).round(@decimals.to_i).to_s("F") 
+        return @item_value if @decimals=="INF"
+        return BigDecimal(@item_value).round(@decimals.to_i).to_s("F")
       end
-      
-      private 
+
+      private
       def to_precision_from_integer(new_value, precision_i)
         factor=10 **(new_value.abs.to_s.length - precision_i)
         return to_big_decimal_float_str(((BigDecimal(new_value.to_s) / factor).to_i * factor).to_s)
       end
-      
+
       def to_big_decimal_float_str(value)
         return BigDecimal(value).to_s("F")
       end
-      
+
     end
-  end 
-  
+  end
+
 end