xbrlware-ce 1.0.2

data/lib/edgar/util.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby
+#
+# Author:: xbrlware@bitstat.com
+#
+# Copyright:: 2009, 2010 bitstat (http://www.bitstat.com). All Rights Reserved.
+#
+# License:: Licensed under the Apache License, Version 2.0 (the "License");
+#           you may not use this file except in compliance with the License.
+#           You may obtain a copy of the License at
+#
+#           http://www.apache.org/licenses/LICENSE-2.0
+#
+#           Unless required by applicable law or agreed to in writing, software
+#           distributed under the License is distributed on an "AS IS" BASIS,
+#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+#           implied.
+#           See the License for the specific language governing permissions and
+#           limitations under the License.
+#
+module Edgar
+  module FileUtil # :nodoc:
+    def mkdir(dir)
+      File.makedirs(dir) unless File.directory?(dir)  
+    end
+    
+    def dump_to_file(file, content)
+      File.open(file, 'w') {|f| f.write(content) }
+    end  
+  end
+end

data/lib/xbrlware.rb

@@ -0,0 +1,65 @@
+#!/usr/bin/ruby
+#
+# Author:: xbrlware@bitstat.com
+#
+# Copyright:: 2009, 2010 bitstat (http://www.bitstat.com). All Rights Reserved.
+#
+# License:: Licensed under the Apache License, Version 2.0 (the "License");
+#           you may not use this file except in compliance with the License.
+#           You may obtain a copy of the License at
+#
+#           http://www.apache.org/licenses/LICENSE-2.0
+#
+#           Unless required by applicable law or agreed to in writing, software
+#           distributed under the License is distributed on an "AS IS" BASIS,
+#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+#           implied.
+#           See the License for the specific language governing permissions and
+#           limitations under the License.
+#
+require 'rubygems'
+gem 'xml-simple', '= 1.0.12'
+require 'xmlsimple'
+
+require 'date'
+require 'bigdecimal'
+require 'erb'
+require 'set'
+require "stringio"
+require 'cgi'
+
+require 'xbrlware/float_patch'
+require 'xbrlware/meta_util'
+require 'xbrlware/hash_util'
+require 'xbrlware/date_util'
+require 'xbrlware/xml_parser'
+
+require 'xbrlware/constants'
+require 'xbrlware/util'
+
+require 'xbrlware/taxonomies/us_gaap_taxonomy_20090131'
+require 'xbrlware/taxonomy'
+
+require 'xbrlware/context'
+require 'xbrlware/instance'
+require 'xbrlware/unit'
+require 'xbrlware/item'
+
+require 'xbrlware/linkbase/linkbase'
+require 'xbrlware/linkbase/label_linkbase'
+require 'xbrlware/linkbase/calculation_linkbase'
+require 'xbrlware/linkbase/definition_linkbase'
+require 'xbrlware/linkbase/presentation_linkbase'
+
+require 'logger'
+require 'benchmark'
+
+ENV["TAXO_NAME"]="US-GAAP"
+ENV["TAXO_VER"]="20090131"
+
+$LOG = Logger.new($stdout)
+$LOG.level = Logger::INFO
+
+def bm(title, measure) # :nodoc:
+  $LOG.debug title +" [ u :"+measure.utime.to_s+", s :"+measure.stime.to_s+", t :"+measure.total.to_s+", r :"+measure.real.to_s+"]"    
+end

data/lib/xbrlware/constants.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby
+#
+# Author:: xbrlware@bitstat.com
+#
+# Copyright:: 2009, 2010 bitstat (http://www.bitstat.com). All Rights Reserved.
+#
+# License:: Licensed under the Apache License, Version 2.0 (the "License");
+#           you may not use this file except in compliance with the License.
+#           You may obtain a copy of the License at
+#
+#           http://www.apache.org/licenses/LICENSE-2.0
+#
+#           Unless required by applicable law or agreed to in writing, software
+#           distributed under the License is distributed on an "AS IS" BASIS,
+#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+#           implied.
+#           See the License for the specific language governing permissions and
+#           limitations under the License.
+#
+module Xbrlware
+  # Linkbase constants
+  module LBConstants
+    CALCULATION="http://www.xbrl.org/2003/role/calculationLinkbaseRef"
+    DEFINITION="http://www.xbrl.org/2003/role/definitionLinkbaseRef"
+    PRESENTATION="http://www.xbrl.org/2003/role/presentationLinkbaseRef"
+    LABEL="http://www.xbrl.org/2003/role/labelLinkbaseRef"
+    REFERENCE="http://www.xbrl.org/2003/role/referenceLinkbaseRef"
+  end
+end

data/lib/xbrlware/context.rb

@@ -0,0 +1,148 @@
+#!/usr/bin/ruby
+#
+# Author:: xbrlware@bitstat.com
+#
+# Copyright:: 2009, 2010 bitstat (http://www.bitstat.com). All Rights Reserved.
+#
+# License:: Licensed under the Apache License, Version 2.0 (the "License");
+#           you may not use this file except in compliance with the License.
+#           You may obtain a copy of the License at
+#
+#           http://www.apache.org/licenses/LICENSE-2.0
+#
+#           Unless required by applicable law or agreed to in writing, software
+#           distributed under the License is distributed on an "AS IS" BASIS,
+#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+#           implied.
+#           See the License for the specific language governing permissions and
+#           limitations under the License.
+#
+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
+    attr_reader :id,:entity,:period, :scenario
+    PERIOD_FOREVER = -1
+    def initialize(id,entity,period, scenario=nil)
+      @id = id
+      @entity = entity
+      @period = period
+      @scenario=scenario
+    end
+    
+    def to_s
+      "Id [" + id + "], Entity { " + @entity.to_s + " },  period ["+period.to_s+"]"+ (",  scenario ["+scenario+"]" unless scenario.nil?).to_s      
+    end
+    
+    def eql?(o)
+      o.is_a?(Context) && @id == o.id
+    end
+    
+    def hash
+      @id.hash
+    end
+    
+    def has_explicit_dimensions?(dimensions=[])
+      return @entity.has_explicit_dimensions?(dimensions) unless @entity.nil?  
+      false
+    end
+
+    alias_method :has_dimensions?, :has_explicit_dimensions?
+
+    def explicit_dimensions
+      return @entity.explicit_dimensions
+    end
+
+    alias_method :dimensions, :explicit_dimensions
+    
+    def explicit_domains(dimensions=[])
+      return @entity.explicit_domains(dimensions)
+    end  
+
+    alias_method :domains, :explicit_domains
+
+    def explicit_dimensions_domains
+      return @entity.explicit_dimensions_domains
+    end
+
+    alias_method :dimensions_domains, :explicit_dimensions_domains
+    
+  end
+  
+  class Entity
+    attr_reader :identifier,:segment
+    def initialize(identifier,segment=nil)
+      @identifier = identifier
+      @segment = segment
+    end
+    
+    def to_s
+      "Identifier { " + @identifier.to_s + " } " + (", segment [" + segment.to_s + "]" unless segment.nil?).to_s
+    end
+    
+    def has_explicit_dimensions?(dimensions=[])
+      dimensions_set=Set.new
+      dimensions_set.merge(dimensions)
+      unless @segment.nil? || @segment["explicitMember"].nil?
+        
+        return true if dimensions.size==0 
+        
+        dim = Set.new
+        @segment["explicitMember"].each do |member|
+          dim << member["dimension"]
+        end
+        return dim.superset?(dimensions_set) 
+      end
+      
+      return false
+    end
+    
+    def explicit_dimensions
+      dim = Set.new
+      unless @segment.nil? || @segment["explicitMember"].nil?
+        @segment["explicitMember"].each do |member|
+          dim << member["dimension"]
+        end
+      end
+      return dim.to_a
+    end
+    
+    def explicit_domains(dimensions=[])
+      dom = Set.new
+      if has_explicit_dimensions?(dimensions)
+        @segment["explicitMember"].each do |member|
+          dimensions=explicit_dimensions if dimensions.size==0
+          dimensions.each do |dim|
+            next unless dim==member["dimension"]
+            dom << member["content"]
+          end
+        end        
+      end
+      return dom.to_a
+    end
+    
+    def explicit_dimensions_domains
+      dim_dom={}
+      if has_explicit_dimensions?
+        @segment["explicitMember"].each do |member|
+          dim_dom[member["dimension"]]=[] if dim_dom[member["dimension"]].nil?
+          dim_dom[member["dimension"]] << member["content"]
+        end   
+      end
+      return dim_dom
+    end
+    
+  end
+  
+  class Identifier 
+    attr_reader :value,:scheme
+    def initialize(scheme,value)
+      @scheme = scheme
+      @value = value
+    end
+    
+    def to_s
+      "schema [" + @scheme.to_s + "], value [" + @value.to_s + "]" 
+    end
+  end
+end

data/lib/xbrlware/date_util.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby
+#
+# Author:: xbrlware@bitstat.com
+#
+# Copyright:: 2009, 2010 bitstat (http://www.bitstat.com). All Rights Reserved.
+#
+# License:: Licensed under the Apache License, Version 2.0 (the "License");
+#           you may not use this file except in compliance with the License.
+#           You may obtain a copy of the License at
+#
+#           http://www.apache.org/licenses/LICENSE-2.0
+#
+#           Unless required by applicable law or agreed to in writing, software
+#           distributed under the License is distributed on an "AS IS" BASIS,
+#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+#           implied.
+#           See the License for the specific language governing permissions and
+#           limitations under the License.
+#
+module Xbrlware
+  module DateUtil # :nodoc:
+    def self.stringify_date (date)
+      return "" if date.nil?
+      _date=Date.parse(date) if date.is_a?(String)
+      _date=date if date.is_a?(Date)
+      m=Date::ABBR_MONTHNAMES[_date.month]
+      m + " " + _date.day.to_s + ", " + _date.year.to_s
+    end
+
+    def self.months_between(date1=Date.today, date2=Date.today)
+      (date1 > date2) ? (recent_date, past_date = date1, date2) : (recent_date, past_date = date2, date1)
+      (recent_date.year - past_date.year) * 12 + (recent_date.month - past_date.month)
+    end
+  end
+end

data/lib/xbrlware/float_patch.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/ruby
+#
+# Author:: xbrlware@bitstat.com
+#
+# Copyright:: 2009, 2010 bitstat (http://www.bitstat.com). All Rights Reserved.
+#
+# License:: Licensed under the Apache License, Version 2.0 (the "License");
+#           you may not use this file except in compliance with the License.
+#           You may obtain a copy of the License at
+#
+#           http://www.apache.org/licenses/LICENSE-2.0
+#
+#           Unless required by applicable law or agreed to in writing, software
+#           distributed under the License is distributed on an "AS IS" BASIS,
+#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+#           implied.
+#           See the License for the specific language governing permissions and
+#           limitations under the License.
+#
+class Float # :nodoc:
+  def round_at(precision)
+    (self * (10 ** precision)).round.to_f / 10 ** precision
+  end
+end
+
+ 

data/lib/xbrlware/hash_util.rb

@@ -0,0 +1,175 @@
+#!/usr/bin/ruby
+#
+# Author:: xbrlware@bitstat.com
+#
+# Copyright:: 2009, 2010 bitstat (http://www.bitstat.com). All Rights Reserved.
+#
+# License:: Licensed under the Apache License, Version 2.0 (the "License");
+#           you may not use this file except in compliance with the License.
+#           You may obtain a copy of the License at
+#
+#           http://www.apache.org/licenses/LICENSE-2.0
+#
+#           Unless required by applicable law or agreed to in writing, software
+#           distributed under the License is distributed on an "AS IS" BASIS,
+#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+#           implied.
+#           See the License for the specific language governing permissions and
+#           limitations under the License.
+#
+module Xbrlware
+  module HashUtil # :nodoc:
+    def self.to_obj(hash)
+      o = Object.new()
+      hash.each do |k, v|
+        v=self.to_obj(v) if v.is_a?(Hash)
+        MetaUtil::introduce_instance_var(o, k, v)
+      end
+      return o
+    end
+
+    # In Ruby 1.9, the Hash is ordered by default.
+    if RUBY_VERSION >= '1.9'
+      OHash = ::Hash
+    else
+      class OHash < Hash #:nodoc:
+        def initialize(*args, &block)
+          super
+          @keys = []
+        end
+
+        def self.[](*args)
+          ordered_hash = new
+
+          if (args.length == 1 && args.first.is_a?(Array))
+            args.first.each do |key_value_pair|
+              next unless (key_value_pair.is_a?(Array))
+              ordered_hash[key_value_pair[0]] = key_value_pair[1]
+            end
+
+            return ordered_hash
+          end
+
+          unless (args.size % 2 == 0)
+            raise ArgumentError.new("odd number of arguments for Hash")
+          end
+
+          args.each_with_index do |val, ind|
+            next if (ind % 2 != 0)
+            ordered_hash[val] = args[ind + 1]
+          end
+
+          ordered_hash
+        end
+
+        def initialize_copy(other)
+          super
+          # make a deep copy of keys
+          @keys = other.keys
+        end
+
+        def []=(key, value)
+          @keys << key if !has_key?(key)
+          super
+        end
+
+        def keys
+          @keys.dup
+        end
+
+        def values
+          @keys.collect { |key| self[key] }
+        end
+
+        def delete(key)
+          if has_key? key
+            index = @keys.index(key)
+            @keys.delete_at index
+          end
+          super
+        end
+
+        def delete_if
+          super
+          sync_keys!
+          self
+        end
+
+        def reject!
+          super
+          sync_keys!
+          self
+        end
+
+        def reject(&block)
+          dup.reject!(&block)
+        end
+
+        def to_hash
+          self
+        end
+
+        def to_a
+          @keys.map { |key| [ key, self[key] ] }
+        end
+
+        def each_key
+          @keys.each { |key| yield key }
+        end
+
+        def each_value
+          @keys.each { |key| yield self[key]}
+        end
+
+        def each
+          @keys.each {|key| yield [key, self[key]]}
+        end
+
+        alias_method :each_pair, :each
+
+        def clear
+          super
+          @keys.clear
+          self
+        end
+
+        def shift
+          k = @keys.first
+          v = delete(k)
+          [k, v]
+        end
+
+        def merge!(other_hash)
+          other_hash.each {|k, v| self[k] = v }
+          self
+        end
+
+        def merge(other_hash)
+          dup.merge!(other_hash)
+        end
+
+        # replace with keys from other Hash. The other Hash could be ordered or not ordered.
+        def replace(other)
+          super
+          @keys = other.keys
+          self
+        end
+
+        def inspect
+          "#<OHash #{super}>"
+        end
+
+        # XmlSimple's export to xml from Hash depends on instance_of?(Hash)
+        def instance_of?(clazz)
+          self.is_a?(clazz)
+        end
+
+        private
+
+        def sync_keys!
+          @keys.delete_if {|k| !has_key?(k)}
+        end
+      end
+    end
+  end
+end