arduino_sketch_builder 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a21314e76b1a911cc53e4b0d20fd38fff6787c4
-  data.tar.gz: ca1a3bc1e35042c4049d11ae3f524cf21a4838f2
+  metadata.gz: 3943bbdef1392adb00d12ef745bcc50f46f36b0f
+  data.tar.gz: e1025545fe5697bc72f739632eb73c5f1e11d19e
 SHA512:
-  metadata.gz: b3f041cbe7406472bec5fd9f3673e4d054e003c037a4fb4dd326ecfd23a6c9c28207188a3abfb567bc49d8ada66049e5677063a90b3a2ca5560b588f37e6484c
-  data.tar.gz: 4a79152cdcc5ac45a0b7c185b2b0c110393273b2fbd20566d026e9a16209edcbaa9900c92883be432256723b12e6ac8854b3f6c8bdb9cc960011d0bb772ea07f
+  metadata.gz: 1d4facb2a74786562f2755ed69a05b7b45ed2e97d92853e1716ccc1292894b9f08fd39bda7d987de2b5d202c7d84992342122c10b032cf631247b5c8242c8245
+  data.tar.gz: 95829a985555e637df41c7c83b15095adabf8d43b9874c3e500ce74bd64203fb7350f28e7284299e0b9f1dff50b46b51248a5bcd6c28063c0fb9602db35f36ed

data/README.md

@@ -21,7 +21,7 @@ Or install it yourself as:
 
 Ruby 2.0.0 or more. 
 
- * If ARDUINO_DEFAULT_BOARD and ARDUINO_DEFAULT_PORT are used to specify the board ID (e.g uno) and the port (e.g. /dev/tty.usbmodem411) instead of passing them to the method in Ruby code, works with Ruby 1.9.3, too. 
+ * If ARDUINO_DEFAULT_BOARD and ARDUINO_DEFAULT_PORT are used to specify the board ID (e.g uno) and the port (e.g. /dev/tty.usbmodem411) instead of passing them as "ketword arguments" to the method in Ruby code, works with Ruby 1.9.3, too. 
  * Strongly recommended to use Ruby 2.0.0 since this gem is intended to use its benefits and Ruby 2.0.0 is compatible with Ruby 1.9.3 if you need to run other code written for Ruby 1.9.3 with this gem. 
 
 Arduino SDK version 0.19 or higher. 
@@ -85,7 +85,9 @@ The default board ID: uno
 
 The default port: /dev/tty.usbmodem411
 
-You can change them by setting ARDUINO_DEFAULT_BOARD and ARDUINO_DEFAULT_PORT environment variables. 
+You can specify them through ArduinoSketchBuilder::Setup.new.setup method (See "Code example" section below). 
+
+You can also change them by setting ARDUINO_DEFAULT_BOARD and ARDUINO_DEFAULT_PORT environment variables at runtime. 
 
 ### Code example
 
@@ -111,6 +113,18 @@ You can change them by setting ARDUINO_DEFAULT_BOARD and ARDUINO_DEFAULT_PORT en
     arduino_sketch_file_path = File.expand_path('~/temp/BlinkCustomized.ino')
     setup.setup(root_directory, arduino_sketch_file_path)  
 
+If Arduino board type and port are different from the default, 
+
+    require "arduino_sketch_builder"
+
+    setup = ArduinoSketchBuilder::Setup.new
+
+    # Configuring ArduinoSketchBuilder (copies cmake directory under the specified root_directory):
+    root_directory = File.expand_path('~/.arduino_sketches')
+    # Path to the sketch to be put under the directory structure:
+    arduino_sketch_file_path = File.expand_path('~/temp/BlinkCustomized.ino')
+    setup.setup(root_directory, arduino_sketch_file_path, board_type: "diecimila", board_port: "/dev/cu.usbmodem411")
+
 #### Executing cmake commands - compile, make, and make upload
 
     require "arduino_sketch_builder"

data/lib/arduino_sketch_builder/setup.rb

@@ -22,7 +22,7 @@ class ArduinoSketchBuilder::Setup
 
   end
 
-  def setup(root_directory, sketch_file_path)
+  def setup(root_directory, sketch_file_path, board_type: "uno", board_port: "/dev/tty.usbmodem411")
 
     sketch_file_name = File.basename(sketch_file_path)
   	sketch_name = sketch_file_name.split('.').first
@@ -35,7 +35,7 @@ class ArduinoSketchBuilder::Setup
 
     c_make_lists_file_generator = ArduinoSketchBuilder::CMakeListsFileGenerator.new
     c_make_lists_file_generator.generate_main(root_directory, File.join(root_directory, main_directory_name))
-    c_make_lists_file_generator.generate_sketch_specific(sketch_name, File.join(root_directory, main_directory_name, 'src'))
+    c_make_lists_file_generator.generate_sketch_specific(sketch_name, File.join(root_directory, main_directory_name, 'src'), board_type: board_type, board_port: board_port)
 
     File.write(File.join(root_directory, main_directory_name, 'src', sketch_name, sketch_file_name), File.read(sketch_file_path))    
 

data/lib/arduino_sketch_builder/version.rb

@@ -1,3 +1,3 @@
 module ArduinoSketchBuilder
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/arduino_sketch_builder/setup_spec.rb

@@ -81,6 +81,33 @@ describe ArduinoSketchBuilder::Setup do
 
     end
 
+    context "Arduino board type and port" do    
+
+      it "should create a directory structure for an Arduino sketch with specified board ID and port" do
+
+        root_directory = TEMP_DIRECTORY
+
+        @setup.setup(root_directory, ARDUINO_SKETCH_FILE_PATH, board_type: "diecimila", board_port: "/dev/cu.usbmodem411")
+
+        Dir.exists?(File.join(root_directory, "blink_customized_for_test")).should be_true
+        File.exists?(File.join(root_directory, "blink_customized_for_test", "CMakeLists.txt")).should be_true
+        Dir.exists?(File.join(root_directory, "blink_customized_for_test", "src")).should be_true
+        File.exists?(File.join(root_directory, "blink_customized_for_test", "src", "CMakeLists.txt")).should be_true
+        Dir.exists?(File.join(root_directory, "blink_customized_for_test", "src", "BlinkCustomizedForTest")).should be_true
+        File.exists?(File.join(root_directory, "blink_customized_for_test", "src", "BlinkCustomizedForTest", "BlinkCustomizedForTest.ino")).should be_true
+        Dir.exists?(File.join(root_directory, "blink_customized_for_test", "build")).should be_true
+
+        # The following checks the generated file with the full path, hence, system specific (e.g. /Users/). 
+        # Hence, it's considered that the unit test for c_make_lists_file_generator covers it. 
+        # File.read(File.join(root_directory, "blink_customized_for_test", "CMakeLists.txt")).should == File.read(File.join(FIXTURES_DIRECTORY, "MainCMakeLists.txt"))
+        # This one also, it's considered that the unit test for c_make_lists_file_generator covers it.
+        # File.read(File.join(root_directory, "blink_customized_for_test", "src", "CMakeLists.txt")).should == File.read(File.join(FIXTURES_DIRECTORY, "CMakeListsForTestSketch2.txt"))
+        File.read(File.join(root_directory, "blink_customized_for_test", "src", "BlinkCustomizedForTest", "BlinkCustomizedForTest.ino")).should == File.read(File.join(ARDUINO_SKETCHES_FIXTURE_DIRECTORY, "src", "BlinkCustomizedForTest", "BlinkCustomizedForTest.ino"))    
+
+      end      
+
+    end
+
   end
 
 end

data/spec/temp/blink_customized_for_test/src/CMakeLists.txt

@@ -1,5 +1,5 @@
-set(ARDUINO_DEFAULT_BOARD uno) # Default Board ID, when not specified
-set(ARDUINO_DEFAULT_PORT /dev/tty.usbmodem411) # Default Port, when not specified
+set(ARDUINO_DEFAULT_BOARD diecimila) # Default Board ID, when not specified
+set(ARDUINO_DEFAULT_PORT /dev/cu.usbmodem411) # Default Port, when not specified
 
 #====================================================================#
 # BlinkCustomizedForTest

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arduino_sketch_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Tadatoshi Takahashi