arduino_sketch_builder 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e29a1ee1ac0e35fdbb247b9acd642b26cfaf8db6
-  data.tar.gz: 838d0585f920ca96720d2b42dab900e1d794c116
+  metadata.gz: 8a21314e76b1a911cc53e4b0d20fd38fff6787c4
+  data.tar.gz: ca1a3bc1e35042c4049d11ae3f524cf21a4838f2
 SHA512:
-  metadata.gz: a64eb3e51947d7cf7327e961590fd1d95517531cab86e2cd7e41c46f980ff1e0d9f46260cd5d47f43e2796bde97946c557239a54f5af5ba8a57f699e31bd732e
-  data.tar.gz: 6a2771b672a28add2eef4db65546755bf8779066822f809f45a462ddabcfb2665619aa0aa0b2c28aa3334a62bfe39dc5f3b2ba001cb29bc1cc830906e8d77fcc
+  metadata.gz: b3f041cbe7406472bec5fd9f3673e4d054e003c037a4fb4dd326ecfd23a6c9c28207188a3abfb567bc49d8ada66049e5677063a90b3a2ca5560b588f37e6484c
+  data.tar.gz: 4a79152cdcc5ac45a0b7c185b2b0c110393273b2fbd20566d026e9a16209edcbaa9900c92883be432256723b12e6ac8854b3f6c8bdb9cc960011d0bb772ea07f

data/README.md

@@ -19,48 +19,132 @@ Or install it yourself as:
 
 ## Requirements
 
-Works with Ruby 1.9.3 and Ruby 2.0.0 (Tested with them). 
+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. 
+ * 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. 
 
-## Usage
+cmake - http://www.cmake.org/cmake/resources/software.html
 
 ### Arduino CMake
 
 This gem uses the code from **Arduino CMake** (https://github.com/queezythegreat/arduino-cmake). 
+
 Originally, **Arduino CMake** was included as GIT submodule in this gem. 
 But there was a problem so now the necessary **Arduino CMake** codes are copied in this gem (arduino-cmake directory). 
 
+## Usage
+
 ### Directory structure
 
+This is based on the directory structure by **Arduino CMake** with modification to make the directory structure for each Arduino sketch indepedent from each other. 
+
+It is also for not putting cmake related files in the default Arduino directory used by Arduino IDE. 
+
+This directory structure can be set up the code from this gem (See "Code example" below). 
+
+Also GIT related files (such as .gitignore and .gitkeep) are automatically added (but doesn't execute GIT commands so if GIT is not used, those files can be simply ignored). 
+
 The default directory structure is 
-  The default directory structure is
-  (root directory)
-    |- cmake
-    |    |- ArduinoToolchain.cmake
-    |    |- Platform
-    |        |- Arduino.cmake  
-    |- (name of Arduino sketch underlined)
-         |--build
-         |--src
-         |   |--(name of Arduino sketch)
-         |        |--(Arduino sketch file)
-         |   |--CMakeLists.txt
-         |--CMakeLists.txt  
+
+    (root directory)
+      |- cmake
+      |    |- ArduinoToolchain.cmake
+      |    |- Platform
+      |        |- Arduino.cmake 
+      |- libraries 
+      |- (name of Arduino sketch underlined)
+           |--build
+           |--src
+           |   |--(name of Arduino sketch)
+           |        |--(Arduino sketch file)
+           |   |--CMakeLists.txt
+           |--CMakeLists.txt  
 
 example:
-  ~/.arduino_sketches  
-    |- cmake
-    |    |- ArduinoToolchain.cmake
-    |    |- Platform
-    |        |- Arduino.cmake  
-    |- blink_customized
-         |--build
-         |--src
-         |   |--BlinkCustomized
-         |        |--BlinkCustomized.ino
-         |   |--CMakeLists.txt
-         |--CMakeLists.txt      
+
+    ~/.arduino_sketches  
+      |- cmake
+      |    |- ArduinoToolchain.cmake
+      |    |- Platform
+      |        |- Arduino.cmake 
+      |- libraries 
+      |- blink_customized
+           |--build
+           |--src
+           |   |--BlinkCustomized
+           |        |--BlinkCustomized.ino
+           |   |--CMakeLists.txt
+           |--CMakeLists.txt    
+
+### Arduino board type and port to access the board
+
+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. 
+
+### Code example
+
+#### Setting up the directory structure - like the one above under cmake directory
+
+    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')
+    setup.configure(root_directory)  
+
+#### Setting up the sketch specific directory structure and files - like the one above under (name of Arduino sketch underlined) directory
+
+    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)  
+
+#### Executing cmake commands - compile, make, and make upload
+
+    require "arduino_sketch_builder"
+
+    main_directory = File.expand_path('~/.arduino_sketches/blink_customized')
+    build_directory = File.join(main_directory, "build")
+
+    # Instantiate ArduinoCmakeBuild with state == :initial (It's a state machine):
+    arduino_cmake_build = ArduinoSketchBuilder::ArduinoCmakeBuild.new(main_directory, build_directory)
+
+    # Execute cmake
+    #   raises error if state at the point of execution is not :initial (i.e. precondition: state == :initial)
+    #   Success: state == :cmake_complete
+    #   Failure: state == :cmake_incomplete
+    #   arduino_cmake_build.message gives message such as error message in case of failure. 
+    state = arduino_cmake_build.cmake
+
+    # Execute make
+    #   raises error if state at the point of execution is not :cmake_complete (i.e. precondition: state == :cmake_complete)
+    #   Success: state == :make_complete
+    #   Failure: state == :make_incomplete
+    #   arduino_cmake_build.message gives message such as error message in case of failure. 
+    state = arduino_cmake_build.make    
+
+    # Execute make upload
+    #   raises error if state at the point of execution is not :make_complete (i.e. precondition: state == :make_complete)  
+    #   Success: state == :make_upload_complete
+    #   Failure: state == :make_upload_incomplete
+    #   arduino_cmake_build.message gives message such as error message in case of failure. 
+    state = arduino_cmake_build.make_upload     
+
+## TODOS
+
+ - The library should be able to be put under (root directory)/libraries
 
 ## Contributing
 

data/lib/arduino_sketch_builder/arduino_cmake_build.rb

@@ -11,7 +11,9 @@ class ArduinoSketchBuilder::ArduinoCmakeBuild
 
   STATE_SEQUENCE = [INITIAL, CMAKE_COMPLETE, MAKE_COMPLETE, MAKE_UPLOAD_COMPLETE]
 
-  def initialize
+  def initialize(main_directory, build_directory)
+    @main_directory = main_directory
+    @build_directory = build_directory
     @state = INITIAL
   end
 
@@ -25,15 +27,15 @@ class ArduinoSketchBuilder::ArduinoCmakeBuild
 
   [:cmake, :make, :make_upload].each_with_index do |method_name, index|
     
-    define_method(method_name) do |build_directory, main_directory=nil|
+    define_method(method_name) do
 
       unless @state == STATE_SEQUENCE[index]
         raise "Wrong state '#{self.state}': can't call #{method_name} when the state is not '#{STATE_SEQUENCE[index].value}'"
       end
 
-      Dir.chdir(build_directory)
+      Dir.chdir(@build_directory)
 
-      Open3.popen3("#{method_name.to_s.sub('_',' ')} #{main_directory ? main_directory : ''}") do |stdin, stdout, stderr, wait_thread|
+      Open3.popen3("#{method_name.to_s.sub('_',' ')} #{method_name == :cmake ? @main_directory : ''}") do |stdin, stdout, stderr, wait_thread|
         pid = wait_thread.pid
         exit_status = wait_thread.value
         if exit_status.success?

data/lib/arduino_sketch_builder/c_make_lists_file_generator.rb

@@ -6,6 +6,8 @@ class ArduinoSketchBuilder::CMakeListsFileGenerator
 
   attr_reader :root_directory
   attr_reader :sketch_name
+  attr_reader :board_type
+  attr_reader :board_port
 
   def generate_main(root_directory, c_make_lists_file_directory)
 
@@ -19,9 +21,11 @@ class ArduinoSketchBuilder::CMakeListsFileGenerator
 
   end
 
-  def generate_sketch_specific(sketch_name, c_make_lists_file_directory)
+  def generate_sketch_specific(sketch_name, c_make_lists_file_directory, board_type: "uno", board_port: "/dev/tty.usbmodem411")
 
   	@sketch_name = sketch_name
+    @board_type = board_type
+    @board_port = board_port
 
     erb = ERB.new(File.read("#{TEMPLATES_DIRECTORY}/SourceCMakeListsTemplate.txt.erb"))
 

data/lib/arduino_sketch_builder/version.rb

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

data/spec/arduino_sketch_builder/arduino_cmake_build_spec.rb

@@ -7,7 +7,7 @@ describe ArduinoSketchBuilder::ArduinoCmakeBuild do
 
   before(:each) do
   	FileUtils.rm_rf(Dir.glob("#{BUILD_DIRECTORY}/*"))
-    @arduino_cmake_build = ArduinoSketchBuilder::ArduinoCmakeBuild.new
+    @arduino_cmake_build = ArduinoSketchBuilder::ArduinoCmakeBuild.new(MAIN_DIRECTORY, BUILD_DIRECTORY)
   end
 
   after(:each) do
@@ -19,19 +19,19 @@ describe ArduinoSketchBuilder::ArduinoCmakeBuild do
     @arduino_cmake_build.state.should == :initial
     File.exists?(File.join(BUILD_DIRECTORY, "Makefile")).should be_false
 
-    @arduino_cmake_build.cmake(BUILD_DIRECTORY, MAIN_DIRECTORY).should == :cmake_complete
+    @arduino_cmake_build.cmake.should == :cmake_complete
 
     @arduino_cmake_build.state.should == :cmake_complete
     File.exists?(File.join(BUILD_DIRECTORY, "Makefile")).should be_true
 
     File.exists?(File.join(BUILD_DIRECTORY, "src", "blink_customized_for_test.hex")).should be_false
 
-    @arduino_cmake_build.make(BUILD_DIRECTORY).should == :make_complete
+    @arduino_cmake_build.make.should == :make_complete
 
     @arduino_cmake_build.state.should == :make_complete
     File.exists?(File.join(BUILD_DIRECTORY, "src", "blink_customized_for_test.hex")).should be_true
 
-    @arduino_cmake_build.make_upload(BUILD_DIRECTORY).should == :make_upload_complete
+    @arduino_cmake_build.make_upload.should == :make_upload_complete
 
     @arduino_cmake_build.state.should == :make_upload_complete
 
@@ -40,19 +40,19 @@ describe ArduinoSketchBuilder::ArduinoCmakeBuild do
   it "should execute cmake only when the state is initial" do
 
     @arduino_cmake_build.instance_eval("@state=CMAKE_COMPLETE")
-    expect { @arduino_cmake_build.cmake(BUILD_DIRECTORY, MAIN_DIRECTORY) }
+    expect { @arduino_cmake_build.cmake }
       .to raise_error("Wrong state 'cmake_complete': can't call cmake when the state is not 'initial'")
     
     @arduino_cmake_build.instance_eval("@state=MAKE_COMPLETE")
-    expect { @arduino_cmake_build.cmake(BUILD_DIRECTORY, MAIN_DIRECTORY) }
+    expect { @arduino_cmake_build.cmake }
       .to raise_error("Wrong state 'make_complete': can't call cmake when the state is not 'initial'")  
 
     @arduino_cmake_build.instance_eval("@state=MAKE_UPLOAD_COMPLETE")
-    expect { @arduino_cmake_build.cmake(BUILD_DIRECTORY, MAIN_DIRECTORY) }
+    expect { @arduino_cmake_build.cmake }
       .to raise_error("Wrong state 'make_upload_complete': can't call cmake when the state is not 'initial'") 
 
     @arduino_cmake_build.instance_eval("@state=INITIAL")
-    expect { @arduino_cmake_build.cmake(BUILD_DIRECTORY, MAIN_DIRECTORY) }
+    expect { @arduino_cmake_build.cmake }
       .to_not raise_error 
 
   end
@@ -60,21 +60,21 @@ describe ArduinoSketchBuilder::ArduinoCmakeBuild do
   it "should execute make only when the state is cmake_complete" do
 
     @arduino_cmake_build.instance_eval("@state=INITIAL")
-    expect { @arduino_cmake_build.make(BUILD_DIRECTORY) }
+    expect { @arduino_cmake_build.make }
       .to raise_error("Wrong state 'initial': can't call make when the state is not 'cmake_complete'")
     
     @arduino_cmake_build.instance_eval("@state=MAKE_COMPLETE")
-    expect { @arduino_cmake_build.make(BUILD_DIRECTORY) }
+    expect { @arduino_cmake_build.make }
       .to raise_error("Wrong state 'make_complete': can't call make when the state is not 'cmake_complete'")  
 
     @arduino_cmake_build.instance_eval("@state=MAKE_UPLOAD_COMPLETE")
-    expect { @arduino_cmake_build.make(BUILD_DIRECTORY) }
+    expect { @arduino_cmake_build.make }
       .to raise_error("Wrong state 'make_upload_complete': can't call make when the state is not 'cmake_complete'") 
 
     @arduino_cmake_build.instance_eval("@state=INITIAL")
-    @arduino_cmake_build.cmake(BUILD_DIRECTORY, MAIN_DIRECTORY)
+    @arduino_cmake_build.cmake
     @arduino_cmake_build.state.should == :cmake_complete
-    expect { @arduino_cmake_build.make(BUILD_DIRECTORY) }
+    expect { @arduino_cmake_build.make }
       .to_not raise_error 
 
   end  
@@ -82,22 +82,22 @@ describe ArduinoSketchBuilder::ArduinoCmakeBuild do
   it "should execute make_upload only when the state is make_complete" do
 
     @arduino_cmake_build.instance_eval("@state=INITIAL")
-    expect { @arduino_cmake_build.make_upload(BUILD_DIRECTORY) }
+    expect { @arduino_cmake_build.make_upload }
       .to raise_error("Wrong state 'initial': can't call make_upload when the state is not 'make_complete'")
     
     @arduino_cmake_build.instance_eval("@state=CMAKE_COMPLETE")
-    expect { @arduino_cmake_build.make_upload(BUILD_DIRECTORY) }
+    expect { @arduino_cmake_build.make_upload }
       .to raise_error("Wrong state 'cmake_complete': can't call make_upload when the state is not 'make_complete'")  
 
     @arduino_cmake_build.instance_eval("@state=MAKE_UPLOAD_COMPLETE")
-    expect { @arduino_cmake_build.make_upload(BUILD_DIRECTORY) }
+    expect { @arduino_cmake_build.make_upload }
       .to raise_error("Wrong state 'make_upload_complete': can't call make_upload when the state is not 'make_complete'") 
 
     @arduino_cmake_build.instance_eval("@state=INITIAL")
-    @arduino_cmake_build.cmake(BUILD_DIRECTORY, MAIN_DIRECTORY)
-    @arduino_cmake_build.make(BUILD_DIRECTORY)
+    @arduino_cmake_build.cmake
+    @arduino_cmake_build.make
     @arduino_cmake_build.state.should == :make_complete
-    expect { @arduino_cmake_build.make_upload(BUILD_DIRECTORY) }
+    expect { @arduino_cmake_build.make_upload }
       .to_not raise_error 
 
   end    

data/spec/arduino_sketch_builder/c_make_lists_file_generator_spec.rb

@@ -32,4 +32,31 @@ describe ArduinoSketchBuilder::CMakeListsFileGenerator do
 
   end
 
+  context "Arduino board type and port" do
+
+    it "should generate CMakeLists.txt file with the default board ID and port if they are not specified" do
+
+      File.exists?(File.join(TEMP_DIRECTORY, "CMakeLists.txt")).should be_false
+
+      @c_make_lists_file_generator.generate_sketch_specific("TestSketch", TEMP_DIRECTORY)
+
+      File.exists?(File.join(TEMP_DIRECTORY, "CMakeLists.txt")).should be_true
+      File.read(File.join(TEMP_DIRECTORY, "CMakeLists.txt")).should == File.read(File.join(FIXTURES_DIRECTORY, "CMakeListsForTestSketch.txt"))      
+
+    end
+
+    it "should generate CMakeLists.txt file with the specified board ID and port" do
+
+      File.exists?(File.join(TEMP_DIRECTORY, "CMakeLists.txt")).should be_false
+
+      @c_make_lists_file_generator.generate_sketch_specific("TestSketch", TEMP_DIRECTORY, board_type: "diecimila", board_port: "/dev/cu.usbmodem411")
+
+      File.exists?(File.join(TEMP_DIRECTORY, "CMakeLists.txt")).should be_true
+      File.read(File.join(TEMP_DIRECTORY, "CMakeLists.txt")).should_not == File.read(File.join(FIXTURES_DIRECTORY, "CMakeListsForTestSketch.txt")) 
+      File.read(File.join(TEMP_DIRECTORY, "CMakeLists.txt")).should == File.read(File.join(FIXTURES_DIRECTORY, "CMakeListsForTestSketch2.txt"))     
+
+    end    
+
+  end
+
 end

data/spec/fixtures/CMakeListsForTestSketch2.txt

@@ -0,0 +1,10 @@
+set(ARDUINO_DEFAULT_BOARD diecimila) # Default Board ID, when not specified
+set(ARDUINO_DEFAULT_PORT /dev/cu.usbmodem411) # Default Port, when not specified
+
+#====================================================================#
+# TestSketch
+#====================================================================#
+generate_arduino_firmware(test_sketch
+    SKETCH TestSketch
+    PROGRAMMER arduino_sketch_builder
+    NO_AUTOLIBS)

data/templates/SourceCMakeListsTemplate.txt.erb

@@ -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 <%= board_type %>) # Default Board ID, when not specified
+set(ARDUINO_DEFAULT_PORT <%= board_port %>) # Default Port, when not specified
 
 #====================================================================#
 # <%= sketch_name %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arduino_sketch_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Tadatoshi Takahashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-01 00:00:00.000000000 Z
+date: 2013-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -70,6 +70,7 @@ files:
 - spec/arduino_sketches_fixture/src/BlinkCustomizedForTest/BlinkCustomizedForTest.ino
 - spec/arduino_sketches_fixture/src/CMakeLists.txt
 - spec/fixtures/CMakeListsForTestSketch.txt
+- spec/fixtures/CMakeListsForTestSketch2.txt
 - spec/fixtures/MainCMakeLists.txt
 - spec/spec_helper.rb
 - spec/temp/blink_customized_for_test/src/BlinkCustomizedForTest/BlinkCustomizedForTest.ino
@@ -111,6 +112,7 @@ test_files:
 - spec/arduino_sketches_fixture/src/BlinkCustomizedForTest/BlinkCustomizedForTest.ino
 - spec/arduino_sketches_fixture/src/CMakeLists.txt
 - spec/fixtures/CMakeListsForTestSketch.txt
+- spec/fixtures/CMakeListsForTestSketch2.txt
 - spec/fixtures/MainCMakeLists.txt
 - spec/spec_helper.rb
 - spec/temp/blink_customized_for_test/src/BlinkCustomizedForTest/BlinkCustomizedForTest.ino