tax_generator 0.1.0 → 0.2.0

data/data/input/taxonomy.xml

@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="utf-8"?>
+<taxonomies>
+<taxonomy>
+<taxonomy_name>World</taxonomy_name>
+<node atlas_node_id = "355064" ethyl_content_object_id="82534" geo_id = "355064">
+<node_name>Africa</node_name>
+<node atlas_node_id = "355611" ethyl_content_object_id="3210" geo_id = "355611">
+<node_name>South Africa</node_name>
+<node atlas_node_id = "355612" ethyl_content_object_id="35474" geo_id = "355612">
+<node_name>Cape Town</node_name>
+<node atlas_node_id = "355613" ethyl_content_object_id="" geo_id = "355613">
+<node_name>Table Mountain National Park</node_name>
+</node>
+</node>
+<node atlas_node_id = "355614" ethyl_content_object_id="" geo_id = "355614">
+<node_name>Free State</node_name>
+<node atlas_node_id = "355615" ethyl_content_object_id="1000550692" geo_id = "355615">
+<node_name>Bloemfontein</node_name>
+</node>
+</node>
+<node atlas_node_id = "355616" ethyl_content_object_id="" geo_id = "355616">
+<node_name>Gauteng</node_name>
+<node atlas_node_id = "355617" ethyl_content_object_id="37710" geo_id = "355617">
+<node_name>Johannesburg</node_name>
+</node>
+<node atlas_node_id = "355618" ethyl_content_object_id="1000548256" geo_id = "355618">
+<node_name>Pretoria</node_name>
+</node>
+</node>
+<node atlas_node_id = "355619" ethyl_content_object_id="" geo_id = "355619">
+<node_name>KwaZulu-Natal</node_name>
+<node atlas_node_id = "355620" ethyl_content_object_id="43725" geo_id = "355620">
+<node_name>Durban</node_name>
+</node>
+<node atlas_node_id = "355621" ethyl_content_object_id="1000576780" geo_id = "355621">
+<node_name>Pietermaritzburg</node_name>
+</node>
+</node>
+<node atlas_node_id = "355622" ethyl_content_object_id="" geo_id = "355622">
+<node_name>Mpumalanga</node_name>
+<node atlas_node_id = "355623" ethyl_content_object_id="67561" geo_id = "355623">
+<node_name>Kruger National Park</node_name>
+</node>
+</node>
+<node atlas_node_id = "355624" ethyl_content_object_id="" geo_id = "355624">
+<node_name>The Drakensberg</node_name>
+<node atlas_node_id = "355625" ethyl_content_object_id="" geo_id = "355625">
+<node_name>Royal Natal National Park</node_name>
+</node>
+</node>
+<node atlas_node_id = "355626" ethyl_content_object_id="" geo_id = "355626">
+<node_name>The Garden Route</node_name>
+<node atlas_node_id = "355627" ethyl_content_object_id="" geo_id = "355627">
+<node_name>Oudtshoorn</node_name>
+</node>
+<node atlas_node_id = "355628" ethyl_content_object_id="" geo_id = "355628">
+<node_name>Tsitsikamma Coastal National Park</node_name>
+</node>
+</node>
+</node>
+<node atlas_node_id = "355629" ethyl_content_object_id="3263" geo_id = "355629">
+<node_name>Sudan</node_name>
+<node atlas_node_id = "355630" ethyl_content_object_id="" geo_id = "355630">
+<node_name>Eastern Sudan</node_name>
+<node atlas_node_id = "355631" ethyl_content_object_id="" geo_id = "355631">
+<node_name>Port Sudan</node_name>
+</node>
+</node>
+<node atlas_node_id = "355632" ethyl_content_object_id="" geo_id = "355632">
+<node_name>Khartoum</node_name>
+</node>
+</node>
+<node atlas_node_id = "355633" ethyl_content_object_id="3272" geo_id = "355633">
+<node_name>Swaziland</node_name>
+</node>
+</node>
+</taxonomy>
+</taxonomies>

data/lib/tax_generator/classes/file_creator.rb

@@ -63,6 +63,15 @@ module TaxGenerator
       @output_folder = job['output_folder']
     end
 
+    #  finds all the nodes in the tree with the given name
+    #
+    # @return [Array<Tree::TreeNode>]
+    #
+    # @api public
+    def atlas_node
+      @taxonomy.find_by_name(@job_id).first
+    end
+
     #  renders the template and creates new file with the template html
     #
     # @return [void]
@@ -91,7 +100,6 @@ module TaxGenerator
     #
     # @api public
     def fetch_atlas_details
-      atlas_node = @taxonomy[@job_id]
       content = @destination.present? ? TaxGenerator::Destination.new(@destination).to_hash : {}
       content.merge(details: atlas_node)
     end

data/lib/tax_generator/classes/taxonomy_tree.rb

@@ -23,12 +23,30 @@ module TaxGenerator
     def initialize(file_path)
       @document = nokogiri_xml(file_path)
       taxonomy_root = @document.at_xpath('//taxonomy_name')
-      @root_node = Tree::TreeNode.new(taxonomy_root.content, nil)
-      @document.xpath('//node').pmap do |taxonomy_node|
+      @root_node = Tree::TreeNode.new('0', taxonomy_root.content)
+      @document.xpath('.//taxonomy/node').pmap do |taxonomy_node|
         add_node(taxonomy_node, @root_node)
       end
     end
 
+    #  finds a node by the name in the tree list
+    #
+    # @param  [String]  node_id the name of the node that needs to be found
+    # @param  [Tree::TreeNode]  node the node that will be used to search in
+    # @param  [Array]  list the list that holds the nodes
+    #
+    # @return [void]
+    #
+    # @api public
+    def find_by_name(node_id, node = @root_node, list = [])
+      if node.name.to_s == node_id.to_s
+        list << node
+      else
+        node.children.each { |child| find_by_name(node_id, child, list) }
+      end
+      list.compact
+    end
+
     #  gets the atlas_id from the nokogiri element and then searches first child whose name is 'node_name'
     # and uses this to insert the node
     # @see #insert_node
@@ -77,7 +95,7 @@ module TaxGenerator
       return unless taxonomy_node.children.any?
       tax_node = add_taxonomy_node(taxonomy_node, node)
       taxonomy_node.xpath('./node').pmap do |child_node|
-        add_taxonomy_node(child_node, tax_node) if tax_node.present?
+        add_node(child_node, tax_node) if tax_node.present?
       end
     end
 

data/lib/tax_generator/version.rb

@@ -15,7 +15,7 @@ module TaxGenerator
     # major release version
     MAJOR = 0
     # minor release version
-    MINOR = 1
+    MINOR = 2
     # tiny release version
     TINY = 0
     # prelease version ( set this only if it is a prelease)

data/spec/lib/tax_generator/classes/file_creator_spec.rb

@@ -8,12 +8,12 @@ describe TaxGenerator::FileCreator do
   let(:subject) { TaxGenerator::FileCreator.new }
   let(:first_destination) { "some destination" }
 
-  let(:fake_node) { FakeNode.new('something') }
+  let(:fake_node) { mock }
 
   let(:atlas_id_value) { 'some atlas id value' }
-  let(:atlas_id) { AtlasID.new(atlas_id_value) }
-  let(:fake_tilt) {FakeTilt.new}
-  let(:fake_condition) {FakeCelluloidCondition.new}
+  let(:atlas_id) { mock }
+  let(:fake_tilt) {mock}
+
 
   let(:job) { { atlas_id: atlas_id_value, taxonomy: fake_node, destination: first_destination, output_folder: output_folder } }
   before(:each) do
@@ -26,9 +26,7 @@ describe TaxGenerator::FileCreator do
     Tilt.stubs(:new).returns(fake_tilt)
     fake_tilt.stubs(:render).returns(true)
     subject.stubs(:mark_job_completed).returns(true)
-    default_processor.stubs(:condition).returns(fake_condition)
     default_processor.stubs(:all_workers_finished).returns(false)
-    fake_condition.stubs(:signal).returns(true)
   end
 
   context 'checks the job keys' do
@@ -59,6 +57,7 @@ describe TaxGenerator::FileCreator do
   context "job related " do
 
     before(:each) do
+
       subject.work(job, default_processor)
       default_processor.stubs(:register_worker_for_job).returns(true)
     end
@@ -72,16 +71,9 @@ describe TaxGenerator::FileCreator do
     end
 
     it 'mark_job_completed' do
-      default_processor.jobs.expects(:[]).with(subject.job_id).returns(job)
-      job.expects(:[]=).with('status', 'finished')
-      default_processor.expects(:all_workers_finished).returns(false)
-      subject.mark_job_completed
-    end
-
-    it 'mark_job_completed and signals complete' do
-      default_processor.expects(:all_workers_finished).returns(true)
-      fake_condition.stubs(:signal).with('completed')
+      default_processor.register_jobs(job)
       subject.mark_job_completed
+      expect(subject.processor.jobs[subject.job_id]).to eq(job.stringify_keys)
     end
 
     it 'fetch_atlas_details' do
@@ -89,7 +81,7 @@ describe TaxGenerator::FileCreator do
       TaxGenerator::Destination.expects(:new).with(first_destination).returns(first_destination)
       first_destination.stubs(:to_hash).returns({})
       actual = subject.fetch_atlas_details
-      expect(actual).to eq({details: fake_node, root: root})
+      expect(actual).to eq({details: fake_node})
     end
   end
 

data/spec/lib/tax_generator/classes/processor_spec.rb

@@ -1,30 +1,83 @@
 # encoding:utf-8
 require 'spec_helper'
 describe TaxGenerator::Processor do
-  let(:subject) {TaxGenerator::Processor.new}
-
-  # it 'parses the xml' do
-  #   subject.expects(:nokogiri_xml).with(destinations_file_path).returns(destination_xml)
-  #   actual = subject.destinations
-  #   expect(actual).to eq destination_xml
-  # end
-  #
-  # it 'generates the files with 0' do
-  #   subject.expects(:create_file).with(0, taxonomy, nil).returns(true)
-  #   subject.generate_files(taxonomy)
-  # end
-  #
-  # it 'searches the destinations' do
-  #   subject.destinations.expects(:xpath).with('//destination').returns([])
-  #   subject.generate_files(taxonomy)
-  # end
-  #
-  # it 'tries to create all the files for all destinations' do
-  #   destination_xml.xpath('//destination').each do |destination|
-  #     destination.expects(:attributes).returns('atlas_id' => atlas_id)
-  #     subject.expects(:create_file).with(atlas_id.value, taxonomy, destination).returns(true)
-  #   end
-  #   subject.generate_files(taxonomy)
-  # end
+
+  let(:actor_pool) {mock}
+  let(:workers) { TaxGenerator::FileCreator.new }
+
+  before(:each) do
+    Celluloid::SupervisionGroup.stubs(:run!).returns(actor_pool)
+    actor_pool.stubs(:pool).returns(workers)
+    Actor.current.stubs(:link).returns(true)
+  end
+
+  context "intialize" do
+
+    it 'boots the celluloid' do
+      Celluloid.expects(:boot).returns(true)
+      TaxGenerator::Processor.new
+    end
+
+    it 'runs the supervision group' do
+      Celluloid::SupervisionGroup.expects(:run!).returns(actor_pool)
+      TaxGenerator::Processor.new
+    end
+
+    it 'creates the pool of workers' do
+      actor_pool.expects(:pool).with(TaxGenerator::FileCreator, as: :workers, size: 50).returns(workers)
+      TaxGenerator::Processor.new
+    end
+
+    it "links the actor to the current actor" do
+      Actor.current.stubs(:link).returns(true)
+      TaxGenerator::Processor.new
+    end
+
+
+  end
+
+  context "intialize" do
+
+    specify { expect(subject.jobs).to eq({}) }
+    specify { expect(subject.job_to_worker).to eq({}) }
+    specify { expect(subject.worker_to_job).to eq({}) }
+  end
+
+
+
+  it 'returns the input folder' do
+    subject.options.expects(:fetch).with(:input_dir, "#{root}/data/input")
+    subject.input_folder
+  end
+
+  it 'returns the output_folder' do
+    subject.options.expects(:fetch).with(:output_dir, "#{root}/data/output")
+    subject.output_folder
+  end
+
+  it 'returns the taxonomy_filename' do
+    subject.options.expects(:fetch).with(:taxonomy_filename, 'taxonomy.xml')
+    subject.taxonomy_file_name
+  end
+
+  it 'returns the destinations_file_name' do
+    subject.options.expects(:fetch).with(:destinations_filename, 'destinations.xml')
+    subject.destinations_file_name
+  end
+
+  it 'returns the taxonomy_file_path' do
+    File.expects(:join).with(subject.input_folder, subject.taxonomy_file_name).returns(true)
+    subject.taxonomy_file_path
+  end
+  it 'returns the destinations_file_path' do
+    File.expects(:join).with(subject.input_folder, subject.destinations_file_name).returns(true)
+    subject.destinations_file_path
+  end
+
+  it 'returns the static_output_dir' do
+    File.expects(:join).with(subject.output_folder, 'static').returns(true)
+    subject.static_output_dir
+  end
+
 
 end

data/spec/spec_helper.rb

@@ -12,31 +12,17 @@ SimpleCov.start 'rails' do
   at_exit {}
 end
 
-# fake class to use for elements that need atlas id as attribute
-AtlasID = Struct.new(:value)
 
-# fake class to use for elements that need atlas id as attribute
-FakeNode = Struct.new(:value)
 
-#fake class for tilt
-class FakeTilt
-
-  def render(*args) end
-end
 
 require 'bundler/setup'
 require 'tax_generator'
 require_relative '../lib/tax_generator/helpers/application_helper'
 require 'rspec'
-# fake class for actors
+#fake actor class
 class Actor
   def self.current
-  end
-end
-
-class FakeCelluloidCondition
-
-  def signal
+    Struct.new(:link)
   end
 end
 
@@ -47,7 +33,6 @@ RSpec.configure do |config|
 
   config.mock_with :mocha
 
-
   config.after(:suite) do
     if SimpleCov.running
       SimpleCov::Formatter::HTMLFormatter.new.format(SimpleCov.result)
@@ -58,3 +43,9 @@ RSpec.configure do |config|
 end
 
 Celluloid.logger = nil
+
+at_exit do
+  Celluloid::Actor.all.each do |actor|
+    Celluloid::Actor.kill(actor)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tax_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - bogdanRada