microstation 0.8.3 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cca38a310ee39f8557bfcdef2653c8ddd7aa71500d35f26a4d42beecd2a67b3
-  data.tar.gz: 422e4761645e7f090668768bb924c06fd1e1408c7f3ef3676f4e065b979bd648
+  metadata.gz: c9e258964e3bdc19c8148e0c28f075c20e4a3b7432671d4738eeb928ec2d3e54
+  data.tar.gz: 24656d582226c6d708c2bb2dc1f05a4e5109bb0ebcd6e2c75ea1c94d0377f495
 SHA512:
-  metadata.gz: 596e5f21984f6398fab508602a72a6f0a944a00839488254c429805a7216d6970daad21a8787e19411f772a09475f505ffb84edd81db928fa97bcdeecce1a138
-  data.tar.gz: 443971dc34318bf02c939450c63f57451973db5d0eddd42ba4a7ee136a9db887b10245c3a8f7f18ba3c61149b69b8315a1d79eeb4130fe66a4105ef0a4c814a7
+  metadata.gz: b251be1af95e568c99fd52ad9cf02ead81681b1decf5c799b35a0d674cb96c457c3011c737658bab1ce52d4620dae59800f0f2a93fbcd4b9b22a09847b4ce9c6
+  data.tar.gz: 8d6220c777a73e1d90182469aa77511a3ceffe8970b94ddb1155d15b1d878ccfdc41a0eb20bfb858c03e55512f9891ad7a739feff2dfc5fb8902b7dc8d68b389

data/Manifest.txt

@@ -7,15 +7,15 @@ Manifest.txt
 README.adoc
 Rakefile
 bin/dgn2pdf
-bin/microstation
 bin/dgn_template
 bin/pw_print
 cad_files/drawing_faatitle_in_non_default_model.dgn
 cad_files/drawing_no_block.dgn
 cad_files/drawing_with_3_block.dgn
 cad_files/drawing_with_block.dgn
+cad_files/drawing_with_text.dgn
 cad_files/seed2d.dgn
-cad_files/test.dgn
+cad_files/seed3d.dgn
 lib/microstation.rb
 lib/microstation/app.rb
 lib/microstation/cad_input_queue.rb
@@ -79,3 +79,13 @@ plot/png.plt
 plot/tiff.plt
 plot/wmbw.tbl
 plot/wmcolor.tbl
+spec/microstation/app_spec.rb
+spec/microstation/configuration_spec.rb
+spec/microstation/drawing_spec.rb
+spec/microstation/functions_spec.rb
+spec/microstation/tag_set_spec.rb
+spec/microstation/template_spec.rb
+spec/microstation/text_node_spec.rb
+spec/microstation/text_spec.rb
+spec/microstation_spec.rb
+spec/spec_helper.rb

data/lib/microstation/version.rb

@@ -1,5 +1,5 @@
 module Microstation
 
-  VERSION = '0.8.3'
+  VERSION = '0.8.4'
 
 end

data/spec/microstation/app_spec.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+
+describe Microstation::App do
+
+  after(:all) do
+      app.quit rescue nil
+  end
+  describe '#initialize' do
+    describe 'visibility' do
+      it 'is invisible with no options' do
+        app = Microstation::App.new
+        _(app).wont_be :visible
+      end
+
+      it 'can be set with option' do
+        app = Microstation::App.new(visible: true)
+        _(app).must_be :visible
+      end
+    end
+  end
+end
+
+describe 'an open Microstation App' do
+  after(:all) do
+      app.quit rescue nil
+  end
+  let(:app) { Microstation::App.new }
+
+  it 'loads the constants' do
+    app
+    _(Microstation::MSD::MsdElementTypeTag).must_equal 37
+  end
+
+  describe '#can_open?' do
+    it 'is true for dgn and dwg files' do
+      %w[dgn dwg].each do |ext|
+        name = "test.#{ext}"
+        _(app.can_open?(name)).must_equal true
+      end
+    end
+
+    it 'is false for other filetypes' do
+      %w[pdf doc jpg pgn].each do |ext|
+        name = "test.#{ext}"
+        _(app.can_open?(name)).wont_equal true
+      end
+    end
+  end
+
+  describe 'open_drawing' do
+    describe 'when valid drawing' do
+      let(:path) { drawing_path('drawing_with_text.dgn') }
+
+      it 'returns a drawing' do
+        drawing = app.open_drawing(path)
+        _(drawing).must_be_instance_of Microstation::Drawing
+        drawing.close
+      end
+
+      describe 'when given a block' do
+        it 'yield the drawing to the block' do
+          app.open_drawing(path) do |d|
+            _(d).must_be_instance_of Microstation::Drawing
+          end
+        end
+
+        it 'closes the drawing after block returns' do
+          _(app.active_design_file).must_be_nil
+          app.open_drawing(path) do |d|
+            _(d).must_be_instance_of Microstation::Drawing
+            _(app.active_design_file).must_be_instance_of Microstation::Drawing
+          end
+          _(app.active_design_file).must_be_nil
+        end
+      end
+    end
+
+    describe 'when a non existent drawing' do
+      it 'raises an error' do
+        _ { app.open_drawing('a_bogus_file.dgn') }.must_raise Microstation::Error
+      end
+    end
+  end
+
+  describe '#ole_obj' do
+    it 'returns an instance of the WIN32OLE' do
+      _(app.ole_obj).must_be_instance_of WIN32OLE
+    end
+  end
+
+  describe '#create_scanner' do
+    it 'can yield a Microstation::Scan::Criteria' do
+      scan = app.create_scanner do |sc|
+        _(sc).must_be_instance_of Microstation::Scan::Criteria
+      end
+    end
+
+    it 'can accept a name' do
+      scanner = app.create_scanner(:my_scanner) do |sc|
+        sc.include_textual
+        sc.include_tags
+      end
+      _(scanner).must_be_instance_of Microstation::Scan::Criteria
+      _(app.scanners[:my_scanner]).must_be_same_as scanner
+    end
+  end
+
+  describe '#normalize_name' do
+    it 'returns the name if the name is absolute' do
+      _(app.normalize_name('c:/my_drawings/test.dgn').to_s).must_equal 'c:/my_drawings/test.dgn'
+    end
+
+    # describe "with relative path"  do
+    #   let(:app){ Microstation::App.new}
+    #   let(:drawing_name){ "test.dgn"}
+
+    #   describe "when project dir is set" do
+    #     app.project_dir = "c:/projects/new"
+    #     _(app.normalize_name(drawing_name)).must_equal "c:/projects/new/#{drawing_name}"
+    #   end
+
+    #   describe "when project dir is not set" do
+    #     _(app.normalize_name(drawing_name)).must_equal (Pathname.getwd + drawing_name).to_s
+    #   end
+
+    # end
+  end
+
+  it 'has a username method' do
+    _(app.username).must_equal ENV['USERNAME']
+  end
+
+  describe '#new_drawing' do
+    let(:new_path) { output_path('new_drawing.dgn') }
+
+    after do
+      app.close_active_drawing
+      File.delete(new_path) if File.exist? new_path
+    end
+
+    it 'needs a filename' do
+      _ { app.new_drawing }.must_raise
+    end
+
+    it 'raises an error if drawing exists' do
+      path = drawing_path('drawing_with_text.dgn')
+      _ { app.new_drawing(path) }.must_raise
+    end
+
+    it 'creates a drawing if the drawing path is new' do
+      drawing = app.new_drawing(new_path)
+      _(drawing).must_be_instance_of Microstation::Drawing
+    end
+
+    describe 'when given a block' do
+      it 'yields the drawing to a block if a block is given' do
+        app.new_drawing(new_path) do |d|
+          _(d).must_be_instance_of Microstation::Drawing
+        end
+      end
+
+      it 'closes drawing after block returns' do
+        _(app.active_design_file).must_be_nil
+        app.new_drawing(new_path) do |d|
+          _(d).must_be_instance_of Microstation::Drawing
+          _(app.active_design_file).must_be_instance_of Microstation::Drawing
+        end
+        _(app.active_design_file).must_be_nil
+      end
+    end
+  end
+
+  describe 'render_template' do
+    describe 'with a valid dgn' do
+      let(:dgn) { drawing_path('drawing_with_block.dgn') }
+
+      it 'completes' do
+        app.render_template(dgn)
+      end
+    end
+  end
+end

data/spec/microstation/configuration_spec.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+
+describe Microstation::Configuration do
+  include Minitest::Hooks
+  before(:all) do 
+    @app = Microstation::App.new
+    config_app(@app)
+  end
+
+  after(:all) do
+    @app.quit rescue nil
+  end
+
+  let(:config) { Microstation::Configuration.new(@app) }
+  let(:defined_name) { 'new_variable' }
+  let(:defined_value) { 'new_variable_value' }
+  let(:undefined_name) { 'undefined_variable' }
+
+  before do
+    config.remove_variable(undefined_name)
+    config.set!(defined_name, defined_value)
+  end
+
+  describe '#remove_variable' do
+    it 'removes an existing variable' do
+      _(config[defined_name]).must_equal defined_value
+      config.remove_variable(defined_name)
+      _(config[defined_name]).must_be_nil
+    end
+
+    it "doesn't error if variable nonexistent" do
+      config.remove_variable 'this_bogus_variable_should_not_exist'
+    end
+  end
+
+  describe '#[]' do
+    it 'should check if value exists' do
+      skip
+      config_mock = Minitest::Mock.new
+      config_mock.expect :exists?, true
+      config.stub :[], config_mock do
+        config['undefined']
+      end
+      config_mock.verify
+    end
+
+    it 'should return the configuration variable if exists' do
+      _(config[defined_name]).must_equal defined_value
+    end
+
+    it 'should return nil if not exists' do
+      _(config[undefined_name]).must_be_nil
+    end
+  end
+
+  describe '[]=, setting variables' do
+    describe 'value not existing yet' do
+      it 'should set the variable' do
+        _(config[undefined_name]).must_be_nil
+        config[undefined_name] = 'its set'
+        _(config[undefined_name]).must_equal 'its set'
+      end
+    end
+
+    describe 'value existing' do
+      it 'should raise variable defined if force option is false' do
+        _ { config[defined_name] = 'my new value' }.must_raise ::Microstation::VariableDefined
+      end
+
+      it 'should keep existing value' do
+        _(config[defined_name]).must_equal defined_value
+        _ { config[defined_name] = 'my new value' }.must_raise
+        _(config[defined_name]).must_equal defined_value
+      end
+
+      it 'should change the variable if force is true' do
+        _(config[defined_name]).must_equal(defined_value)
+        config.set!(defined_name, 'my new value')
+        _(config[defined_name]).must_equal 'my new value'
+      end
+    end
+  end
+
+  describe '#exists' do
+    it 'should return true if config variable exists' do
+      _((config).exists?(defined_name)).must_equal true
+    end
+
+    it "should return false if config variable doesn't exist" do
+      _(config.exists?(undefined_name)).wont_equal true
+    end
+  end
+
+  describe '#prepend' do
+    describe 'variable exists' do
+      it 'should prepend the value' do
+        value_before = config[defined_name]
+        config.prepend(defined_name, 'added')
+        value_after = config[defined_name]
+        _(value_after).must_equal "added;#{value_before}"
+      end
+
+      describe 'variable nonexistent' do
+        it 'should add the value' do
+          value_before = config[undefined_name]
+          config.prepend(undefined_name, 'added')
+          value_after = config[undefined_name]
+          _(value_after).must_equal 'added'
+        end
+      end
+    end
+  end
+
+  describe '#expand' do
+    let(:dir) {}
+
+    before do
+      config['DIR'] = 'c:/Users/Tom'
+    end
+
+    after do
+      config.remove_variable('DIR')
+    end
+
+    it 'should expand the string' do
+      _(config.expand('$(DIR)/project')).must_equal 'c:/Users/Tom/project'
+    end
+  end
+end

data/spec/microstation/drawing_spec.rb

@@ -0,0 +1,245 @@
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+
+$LOAD_PATH.unshift(File.join(__dir__, '../lib'))
+
+# require 'minitest/spec'
+# require 'minitest/autorun'
+
+describe 'Lets start the Microstation once' do
+  include Minitest::Hooks
+  before(:all) do
+    @app = Microstation::App.new
+    config_app(@app)
+  end
+
+  after(:all) do
+    @app.quit rescue nil
+  end
+
+  describe 'a drawing created with app.new drawing' do
+    let(:drawing) { new_drawing('temp.dgn', seedfile: 'seed2d') }
+
+    it 'should be active drawing' do
+      _(drawing).must_be :active?
+    end
+
+    it 'should have an ole_obj' do
+      _(drawing.ole_obj).must_be_instance_of WIN32OLE
+    end
+
+    describe '#author' do
+      it "should be '' for new drawing" do
+        skip
+        _(drawing.author).must_equal ''
+      end
+
+      it 'should set author if given a new author' do
+        drawing.author = 'A newer author'
+        _(drawing.author).must_equal 'A newer author'
+      end
+    end
+
+    describe '#title' do
+      it "should be '' to start" do
+        expect(drawing.title).must_equal('')
+      end
+
+      it 'should set title if given a new title' do
+        drawing.title = 'a new title'
+        expect(drawing.title).must_equal 'a new title'
+      end
+    end
+
+    describe '#keywords' do
+      it 'should be empty string to start' do
+        _(drawing.keywords).must_equal ''
+      end
+
+      it 'should set keywords if given a string of words' do
+        drawing.keywords = 'project, rcl, new'
+        _(drawing.keywords).must_equal 'project, rcl, new'
+      end
+    end
+
+    describe '#comments' do
+      it 'should be nil to start' do
+        _(drawing.comments).must_equal ''
+      end
+
+      it 'should be able to be set' do
+        drawing.comments = 'these are comments'
+        _(drawing.comments).must_equal 'these are comments'
+      end
+    end
+
+    it 'should be able to save as pdf' do
+      drawing.save_as_pdf
+    end
+
+    describe 'revision count' do
+      it 'should have a revision_count' do
+        _(drawing).must_respond_to(:revision_count)
+      end
+
+      it 'should forward revision count to ole_obj' do
+        skip
+        ole = drawing.ole_obj
+        ole.stub :DesignRevisionCount, true do
+          assert drawing.revision_count
+        end
+      end
+    end
+
+    describe 'pdf_name' do
+      describe 'with no args' do
+        it 'should equal the drawing path with ext changed' do
+          drawing.stub(:name, 'Drawing Name.dgn') do
+            _(drawing.pdf_name.to_s).must_equal 'Drawing Name.pdf'
+          end
+        end
+      end
+
+      describe 'with  arg for name' do
+        it 'should equal the arg and the current directory' do
+          _(drawing.pdf_name('my_drawing').to_s).must_equal('my_drawing.pdf')
+        end
+      end
+    end
+
+    describe 'save_as_pdf' do
+      it 'should find the pdf name with pdf_name rules' do
+        skip
+        path = drawing.path
+        _(drawing).to receive(:pdf_name).with('testfile', nil)
+        drawing.save_as_pdf('testfile')
+      end
+    end
+
+    describe 'scanning' do
+      it 'should have a #create_scanner' do
+        scanner = drawing.create_scanner(:test)
+        _(scanner).must_be_instance_of Microstation::Scan::Criteria
+      end
+
+      it 'should scan the drawing' do
+        scanner = drawing.create_scanner(:test) do |scan|
+          _(scan).must_be_instance_of Microstation::Scan::Criteria
+        end
+        drawing.scan_model(scanner)
+      end
+    end
+
+    describe '#scan_text' do
+      it 'only yields textual items' do
+        drawing.scan_text do |item|
+          _(item.class).must_equal(Microstation::Text || Microstation::TextNode)
+        end
+      end
+    end
+
+    describe '#update_tagset' do
+      describe 'when 1 block exists' do
+      end
+
+      describe 'when 1 block not in default drawing' do
+        let(:drawing) { new_drawing('test.dgn', seedfile: 'drawing_faatitle_in_non_default_model.dgn') }
+        let(:app) { @app }
+
+        it 'finds tagsets in drawing' do
+          tagsets = drawing.tagsets_in_drawing.to_a
+          _(tagsets.size).must_be :>, 0
+        end
+
+        it 'updates tagset' do
+          ts = drawing.find_tagset_instance_by_name('faatitle')
+          ts_title = ts['title1'].to_s
+          _(ts_title).must_equal('TITLE 1')
+          drawing.update_tagset('faatitle', { 'title1' => 'MY NEW TITLE' })
+          ts = drawing.find_tagset_instance_by_name('faatitle')
+          _(ts['title1'].to_s).must_equal('MY NEW TITLE')
+        end
+      end
+      describe 'when multiple blocks' do
+        let(:drawing) { new_drawing('test.dgn', seedfile: 'drawing_with_3_block.dgn') }
+        let(:panel_atts) { { 'brk_1_service' => 'OUTLETS', 'brk_2_service' => 'AIR CONDITIONER' } }
+        let(:app) { @app }
+
+        before do
+          before_new_drawing
+        end
+
+        describe '#save_tagsets' do
+          it 'saves the atts to a file' do
+            drawing.save_tagsets_to_file("#{Microstation::ROOT}drawing_atts.txt")
+          end
+        end
+
+        describe 'with no microstation_id' do
+          it 'errors' do
+            _ { drawing.update_tagset('electrical_panel_42', panel_atts) }.must_raise Microstation::MultipleUpdateError
+          end
+        end
+
+        describe 'when multiple blocks exist and microstation_id' do
+          it 'updates drawing with block' do
+            ts = drawing.find_tagset_instance_by_name_and_id('electrical_panel_42', 324)
+            _(ts.brk_1_service).must_equal('')
+            _(ts.brk_2_service).must_equal('')
+            panel = panel_atts.merge({ 'microstation_id' => 324 })
+            drawing.update_tagset('electrical_panel_42', panel)
+            ts = drawing.find_tagset_instance_by_name_and_id('electrical_panel_42', 324)
+            _(ts.brk_2_service).must_equal('AIR CONDITIONER')
+            _(ts.brk_1_service).must_equal('OUTLETS')
+          end
+        end
+      end
+    end
+    describe '#get_text' do
+      describe 'drawing with no text' do
+        let(:drawing) { open_existing_drawing('drawing_no_block.dgn') }
+        it 'returns empty array if text has no text' do
+          _(drawing.get_text.to_a).must_equal([])
+        end
+      end
+
+      describe 'drawing_with_text in block' do
+        let(:drawing) { open_existing_drawing('drawing_with_block.dgn') }
+        let(:text_in_drawing) do
+          ['text1 {{ a1 }}',
+           'text2 {{ a2 }}',
+           'text3 {{ a3 }}',
+           "node1 {{ a4 }}\nnode1 {{ a5 }}",
+           "node2 {{ a7 }}\nnode2 {{ a7 }}",
+           'text a1 again {{ a1 }}']
+        end
+
+        it 'gets all the text if drawing has text' do
+          text_from_drawing = drawing.get_text
+          _(text_from_drawing.to_a.sort).must_equal(text_in_drawing.sort)
+        end
+      end
+    end
+
+    describe '2d and 3d' do
+      describe 'when have a 2d drawing' do
+        let(:drawing) { new_drawing('temp.dgn', seedfile: 'seed2d') }
+
+        it 'should  be 2d and not 3d two_d? ' do
+          _(drawing).must_be :two_d?
+          _(drawing).wont_be :three_d?
+        end
+      end
+
+      describe 'when we have a 3d drawing' do
+        let(:drawing) { new_drawing('temp.dgn', seedfile: 'seed3d') }
+
+        it 'should be 3d and not 2d' do
+          _(drawing).must_be :three_d?
+          _(drawing).wont_be :two_d?
+        end
+      end
+    end
+  end
+end