hdo-storting-importer 0.0.4 → 0.0.5

data/lib/hdo/storting_importer/api_data_source.rb

@@ -3,7 +3,6 @@ module Hdo
     class ApiDataSource < DataSource
 
       def initialize(url)
-        @log = Logger.new(STDERR)
         @resource = RestClient::Resource.new(URI.parse(url))
       end
 
@@ -51,7 +50,7 @@ module Hdo
 
       def fetch(path)
         sub_resource = @resource[path]
-        @log.info "parsing #{sub_resource}"
+        Hdo::StortingImporter.logger.info "parsing #{sub_resource}"
 
         parse sub_resource.get
       end

data/lib/hdo/storting_importer/category.rb

@@ -2,6 +2,7 @@ module Hdo
   module StortingImporter
     class Category
       include IvarEquality
+      include Inspectable
 
       attr_reader :external_id, :name
       attr_accessor :children
@@ -22,11 +23,15 @@ module Hdo
         ]
       end
 
-      def self.xml_example(builder = Util.builder)
+      def self.example
         cat = new("5", "Employment")
         cat.children << new("6", "Wages")
 
-        cat.to_hdo_xml(builder)
+        cat
+      end
+
+      def self.xml_example(builder = Util.builder)
+        example.to_hdo_xml(builder)
       end
 
       #
@@ -90,6 +95,10 @@ module Hdo
         @children    = []
       end
 
+      def short_inspect
+        short_inspect_string :include => [:external_id, :name]
+      end
+
       #
       # Serialize as HDO XML
       #

data/lib/hdo/storting_importer/cli.rb

@@ -2,7 +2,6 @@ module Hdo
   module StortingImporter
     class CLI
       def initialize(args)
-        @log = Logger.new(STDERR)
         @type, @files, @options = parse(args)
       end
 

data/lib/hdo/storting_importer/committee.rb

@@ -4,6 +4,7 @@ module Hdo
       include IvarEquality
 
       attr_reader :external_id, :name
+      alias_method :short_inspect, :inspect
 
       def self.type_name
         'committee'
@@ -13,8 +14,12 @@ module Hdo
         'a parliamentary committe'
       end
 
+      def self.example
+        new "ARBSOS", "Arbeids- og sosialkomiteen"
+      end
+
       def self.xml_example(builder = Util.builder)
-        new("ARBSOS", "Arbeids- og sosialkomiteen").to_hdo_xml(builder)
+        example.to_hdo_xml(builder)
       end
 
       def self.fields

data/lib/hdo/storting_importer/disk_data_source.rb

@@ -4,7 +4,6 @@ module Hdo
 
       def initialize(root)
         @root = Pathname.new(root)
-        @log = Logger.new(STDERR)
       end
 
       def parties(session_id = DEFAULT_SESSION)
@@ -51,7 +50,7 @@ module Hdo
 
       def fetch(path)
         subpath = @root.join(path)
-        @log.info "parsing #{subpath}"
+        Hdo::StortingImporter.logger.info "parsing #{subpath}"
 
         parse subpath.read
       end

data/lib/hdo/storting_importer/district.rb

@@ -4,6 +4,7 @@ module Hdo
       include IvarEquality
 
       attr_reader :external_id, :name
+      alias_method :short_inspect, :inspect
 
       def self.type_name
         'district'
@@ -13,8 +14,12 @@ module Hdo
         'an electoral district'
       end
 
+      def self.example
+        new("Db", "Duckburg")
+      end
+
       def self.xml_example(builder = Util.builder)
-        new("Db", "Duckburg").to_hdo_xml(builder)
+        example.to_hdo_xml(builder)
       end
 
       def self.fields

data/lib/hdo/storting_importer/inspectable.rb

@@ -0,0 +1,27 @@
+module Hdo
+  module StortingImporter
+    module Inspectable
+      def short_inspect_string(opts)
+        if excluded_ivars = opts[:exclude]
+          excluded_ivars.map! { |ivar| ivar.to_sym }
+          all_ivars = instance_variables.map { |e| e.to_sym }
+          ivars = all_ivars - excluded_ivars
+        elsif included_ivars = opts[:include]
+          included_ivars.map! { |ivar| "@#{ivar}".to_sym }
+          ivars = included_ivars
+        else
+          raise ArgumentError, "unknown arg: #{opts.inspect}"
+        end
+
+        ivars.map! do |ivar|
+          val = instance_variable_get(ivar)
+          str = val.respond_to?(:short_inspect) ? val.short_inspect : val.inspect
+
+          "#{ivar}=#{str}"
+        end
+
+        '#<%s:0x%s %s>' % [self.class.name, self.hash.to_s(16), ivars.join(" ").strip]
+      end
+    end
+  end
+end

data/lib/hdo/storting_importer/issue.rb

@@ -4,6 +4,7 @@ module Hdo
   module StortingImporter
     class Issue
       include IvarEquality
+      include Inspectable
 
       attr_reader :external_id, :summary, :description, :type, :status, :last_update,
                   :reference, :document_group, :committee, :categories
@@ -115,6 +116,10 @@ module Hdo
         @categories     = categories || []
       end
 
+      def short_inspect
+        short_inspect_string :include => [:external_id, :summary]
+      end
+
       def to_hdo_xml(builder = Util.builder)
         builder.issue do |i|
           i.externalId external_id

data/lib/hdo/storting_importer/party.rb

@@ -4,6 +4,7 @@ module Hdo
       include IvarEquality
 
       attr_reader :external_id, :name
+      alias_method :short_inspect, :inspect
 
       def self.type_name
         'party'
@@ -13,8 +14,12 @@ module Hdo
         'a political party'
       end
 
+      def self.example
+        new("DEM", "Democratic Party")
+      end
+
       def self.xml_example(builder = Util.builder)
-        new("DEM", "Democratic Party").to_hdo_xml(builder)
+        example.to_hdo_xml(builder)
       end
 
       def self.fields

data/lib/hdo/storting_importer/promise.rb

@@ -7,6 +7,7 @@ module Hdo
     class Promise
       attr_reader :party, :body, :general, :categories, :source, :page
       alias_method :general?, :general
+      alias_method :short_inspect, :inspect
 
       def self.type_name
         'promise'

data/lib/hdo/storting_importer/representative.rb

@@ -4,6 +4,7 @@ module Hdo
   module StortingImporter
     class Representative
       include IvarEquality
+      include Inspectable
 
       attr_reader :external_id, :first_name, :last_name, :date_of_birth, :date_of_death,
                   :district, :party, :committees, :period, :gender
@@ -125,6 +126,10 @@ module Hdo
         @vote_result   = nil
       end
 
+      def short_inspect
+        short_inspect_string :include => [:external_id, :first_name, :last_name, :party, :vote_result]
+      end
+
       def external_id
         Util.unescape_param @external_id
       end

data/lib/hdo/storting_importer/version.rb

@@ -1,5 +1,5 @@
 module Hdo
   module StortingImporter
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/lib/hdo/storting_importer/vote.rb

@@ -4,6 +4,7 @@ module Hdo
   module StortingImporter
     class Vote
       include IvarEquality
+      include Inspectable
 
       attr_reader :external_id, :external_issue_id, :personal, :enacted, :subject,
                   :method, :result_type, :time, :counts
@@ -117,6 +118,10 @@ module Hdo
         @representatives = []
       end
 
+      def short_inspect
+        short_inspect_string :include => [:external_id, :subject, :time, :counts]
+      end
+
       def add_storting_propositions(node)
         @propositions += node.css("voteringsforslag").map do |n|
           rep_node = n.css("forslag_levert_av_representant").first
@@ -186,7 +191,12 @@ module Hdo
       class Counts < Struct.new(:for, :against, :absent)
       end
 
-      class Proposition < Struct.new(:external_id, :description, :on_behalf_of, :body, :delivered_by)
+      class Proposition
+        include IvarEquality
+        include Inspectable
+
+        attr_reader :external_id, :description, :on_behalf_of, :body, :delivered_by
+
         def self.type_name
           'proposition'
         end
@@ -225,6 +235,18 @@ module Hdo
           new external_id, description, on_behalf_of, body, delivered_by
         end
 
+        def initialize(external_id, description, on_behalf_of, body, delivered_by)
+          @external_id  = external_id
+          @description  = description
+          @on_behalf_of = on_behalf_of
+          @body         = body
+          @delivered_by = delivered_by
+        end
+
+        def short_inspect
+          short_inspect_string :include => [:external_id, :description, :on_behalf_of]
+        end
+
         def to_hdo_xml(builder)
           builder.proposition do |pr|
             pr.externalId external_id

data/lib/hdo/storting_importer.rb

@@ -1,24 +1,44 @@
+require 'nokogiri'
+require 'restclient'
+require 'tempfile'
+require 'pathname'
+require 'open-uri'
+require 'erb'
+require 'logger'
+
 module Hdo
   module StortingImporter
     def self.root
       @root ||= File.expand_path("../../..", __FILE__)
     end
 
+    def self.logger
+      @logger ||= (
+        out = $stderr # should be able to pipe output to a file
+
+        if defined?(Rails)
+          klass = Class.new(Logger) do
+            def format_message(severity, timestamp, progname, msg)
+              "#{timestamp.to_formatted_s(:db)} #{severity} #{msg}\n"
+            end
+          end
+
+          klass.new(out)
+        else
+          Logger.new(out)
+        end
+      )
+
+    end
+
     Field = Struct.new(:name, :required, :type, :description)
     EXTERNAL_ID_FIELD = Field.new(:externalId, false, :string, 'An optional external id, matching potential id fields in the input data. This is useful if you want to reimport previous data without creating duplicates.')
   end
 end
 
-require 'nokogiri'
-require 'restclient'
-require 'tempfile'
-require 'pathname'
-require 'open-uri'
-require 'erb'
-require 'logger'
-
 require 'hdo/storting_importer/core_ext/enumerable'
 require 'hdo/storting_importer/ivar_equality'
+require 'hdo/storting_importer/inspectable'
 require 'hdo/storting_importer/util'
 
 require 'hdo/storting_importer/data_source'

data/spec/hdo/storting_importer/category_spec.rb

@@ -94,6 +94,9 @@ module Hdo
         Category.fields.should_not be_empty
       end
 
+      it 'has #short_inspect' do
+        Category.example.short_inspect.should be_kind_of(String)
+      end
 
     end
   end

data/spec/hdo/storting_importer/committee_spec.rb

@@ -61,6 +61,9 @@ module Hdo
         Committee.fields.should_not be_empty
       end
 
+      it 'has #short_inspect' do
+        Committee.example.short_inspect.should be_kind_of(String)
+      end
 
     end
   end

data/spec/hdo/storting_importer/district_spec.rb

@@ -69,6 +69,11 @@ module Hdo
         District.fields.should_not be_empty
       end
 
+      it 'has #short_inspect' do
+        District.example.short_inspect.should be_kind_of(String)
+      end
+
+
 
     end
   end

data/spec/hdo/storting_importer/issue_spec.rb

@@ -116,6 +116,10 @@ XML
         Issue.fields.should_not be_empty
       end
 
+      it 'has #short_inspect' do
+        Issue.example.short_inspect.should be_kind_of(String)
+      end
+
     end
   end
 end

data/spec/hdo/storting_importer/party_spec.rb

@@ -72,6 +72,10 @@ module Hdo
         party.external_id.should == "ÆØÅ"
       end
 
+      it 'has #short_inspect' do
+        Party.example.short_inspect.should be_kind_of(String)
+      end
+
     end
   end
 end

data/spec/hdo/storting_importer/promise_spec.rb

@@ -89,6 +89,10 @@ XML
         Promise.xml_example.should be_kind_of(String)
       end
 
+      it 'has #short_inspect' do
+        Promise.example.short_inspect.should be_kind_of(String)
+      end
+
     end
   end
 end

data/spec/hdo/storting_importer/representative_spec.rb

@@ -100,6 +100,10 @@ module Hdo
         rep.external_id.should == "ÆØÅ"
       end
 
+      it 'has #short_inspect' do
+        Representative.example.short_inspect.should be_kind_of(String)
+      end
+
     end
   end
 end

data/spec/hdo/storting_importer/vote_spec.rb

@@ -162,6 +162,14 @@ module Hdo
         Vote.fields.should_not be_empty
       end
 
+      it 'has #short_inspect' do
+        Vote.example.short_inspect.should be_kind_of(String)
+
+        str = Vote::Proposition.example.short_inspect
+        str.should be_kind_of(String)
+        str.should_not include("nil")
+      end
+
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hdo-storting-importer
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -120,6 +120,7 @@ files:
 - lib/hdo/storting_importer/data_source.rb
 - lib/hdo/storting_importer/disk_data_source.rb
 - lib/hdo/storting_importer/district.rb
+- lib/hdo/storting_importer/inspectable.rb
 - lib/hdo/storting_importer/issue.rb
 - lib/hdo/storting_importer/ivar_equality.rb
 - lib/hdo/storting_importer/parsing_data_source.rb