arduino_sketch_builder 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1be6df6bc58e73cc36b048ab1e084d9d357d72e
-  data.tar.gz: 0e977b8e24e0c2036b362704299bfeb7b9e03262
+  metadata.gz: f82dae0085b54f68c8289afb826a1ecf04358f17
+  data.tar.gz: 9cbfff32a488a0ed397f049b5b384eb7f5136477
 SHA512:
-  metadata.gz: d3f0f52a4c5d167183e770dcec3dd8a92db989fd099b0b8a74c16ad538bd25764cfbc1fd4eb27910c05f99d399cd5ae958e91f63c3f5c664939e855be79bfade
-  data.tar.gz: 70133a5475284e60f81737ef32f1a9ccb1de3262f996e16b47e020177347d2ffd7f72454dadc279f5847bef49dcbcba3d0df38d08791d460e2b0b27dbe8f6338
+  metadata.gz: 1f3efede1b98b9a2ec323f85366ce9fc25bc2550851f6601126c7f7267c0c1d9345193df1572852e9af724dfa2e57ae5f80e46ad899f1b3659d6166683574f3f
+  data.tar.gz: 4d160df5b0a6cb8a1b045d1865452a43d8010a879d82a179dbf73431d8d602613396b42ca14bddacdd5860eacec2b12cbd325afa99b8fa258b921a020996e8e6

data/README.md

@@ -82,21 +82,44 @@ The default board ID: uno
 
 The default port: /dev/tty.usbmodem411
 
-You can specify them through ArduinoSketchBuilder::Setup.new.setup method (See "Code example" section below). 
+You can specify them through ArduinoSketchBuilder::Base.new (See "Simple code example" section below). 
 
 You can also change them by setting ARDUINO_DEFAULT_BOARD and ARDUINO_DEFAULT_PORT environment variables at runtime. 
 
-### Code example
+### Simple code example (following the default directory structure above)
+
+    require "arduino_sketch_builder"
+
+    # Configuring ArduinoSketchBuilder (copies cmake directory under the specified root_directory):
+    root_directory = File.expand_path('~/.arduino_sketches')
+
+    # Setting up the directory structure - like the one above under cmake directory
+    ArduinoSketchBuilder::Setup.configure(root_directory)  
+
+    # Path to the sketch to be put under the directory structure:
+    arduino_sketch_file_path = File.expand_path('~/temp/BlinkCustomized.ino')
+
+    arduino_sketch_builder = ArduinoSketchBuilder::Base.new(root_directory, arduino_sketch_file_path, board_type: "diecimila", board_port: "/dev/cu.usbmodem411")
+
+    # Setting up the sketch specific directory structure and files - like the one above under (name of Arduino sketch underlined) directory
+    arduino_sketch_builder.setup_sketch
+
+    # Build and upload
+    #   raises error if state at the point of execution is not :initial (i.e. precondition: state == :initial)  
+    #   Success: state == :complete
+    #   Failure: state == :cmake_incomplete, :make_incomplete, or :make_upload_incomplete depending on the step at the time of the failure
+    #   arduino_sketch_builder.message gives message such as error message in case of failure.  
+    state = arduino_sketch_builder.build_and_upload
+
+### Example of code with more control
 
 #### 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)  
+    ArduinoSketchBuilder::Setup.configure(root_directory)  
 
 #### Setting up the sketch specific directory structure and files - like the one above under (name of Arduino sketch underlined) directory
 
@@ -122,24 +145,7 @@ If Arduino board type and port are different from the default,
     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")
 
-#### Building and uploading the sketch
-
-    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)
-
-    # Build and upload
-    #   raises error if state at the point of execution is not :initial (i.e. precondition: state == :initial)  
-    #   Success: state == :make_upload_complete
-    #   Failure: state == :cmake_incomplete, :make_incomplete, or :make_upload_incomplete depending on the step at the time of the failure
-    #   arduino_cmake_build.message gives message such as error message in case of failure. 
-    state = arduino_cmake_build.build_and_upload      
-
-#### (Optional: individual steps for "Building and uploading the sketch" above): Executing cmake commands - compile, make, and make upload
+#### Executing cmake commands - compile, make, and make upload
 
     require "arduino_sketch_builder"
 

data/lib/arduino_sketch_builder/arduino_cmake_build.rb

@@ -1,4 +1,5 @@
 require "open3"
+require "fileutils"
 
 class ArduinoSketchBuilder::ArduinoCmakeBuild
 
@@ -8,12 +9,13 @@ class ArduinoSketchBuilder::ArduinoCmakeBuild
   CMAKE_COMPLETE = State.new(:cmake_complete, "success") 
   MAKE_COMPLETE = State.new(:make_complete, "success")
   MAKE_UPLOAD_COMPLETE = State.new(:make_upload_complete, "success")
+  COMPLETE = State.new(:complete, "success")
 
-  STATE_SEQUENCE = [INITIAL, CMAKE_COMPLETE, MAKE_COMPLETE, MAKE_UPLOAD_COMPLETE]
+  STATE_SEQUENCE = [INITIAL, CMAKE_COMPLETE, MAKE_COMPLETE, MAKE_UPLOAD_COMPLETE, COMPLETE]
 
   def initialize(main_directory, build_directory)
-    @main_directory = main_directory
-    @build_directory = build_directory
+    @main_directory = File.expand_path(main_directory)
+    @build_directory = File.expand_path(build_directory)
     @state = INITIAL
   end
 
@@ -27,10 +29,13 @@ class ArduinoSketchBuilder::ArduinoCmakeBuild
 
   def build_and_upload
     self.cmake
-    return self.state unless self.state == :cmake_complete
+    return self.state unless @state == CMAKE_COMPLETE
     self.make
-    return self.state unless self.state == :make_complete
+    return self.state unless @state == MAKE_COMPLETE
     self.make_upload
+    @state = COMPLETE if @state == MAKE_UPLOAD_COMPLETE
+
+    self.state
   end
 
   [:cmake, :make, :make_upload].each_with_index do |method_name, index|
@@ -59,4 +64,13 @@ class ArduinoSketchBuilder::ArduinoCmakeBuild
 
   end
 
+  def reset
+
+    FileUtils.rm_rf(Dir.glob("#{BUILD_DIRECTORY}/*"))
+    @state = INITIAL
+
+    self.state
+
+  end
+
 end

data/lib/arduino_sketch_builder/base.rb

@@ -0,0 +1,37 @@
+require 'active_support/core_ext/string/inflections'
+
+class ArduinoSketchBuilder::Base
+
+  def initialize(root_directory, sketch_file_path, board_type: "uno", board_port: "/dev/tty.usbmodem411")
+    @root_directory = File.expand_path(root_directory)
+    @sketch_file_path = File.expand_path(sketch_file_path)
+    @board_type = board_type
+    @board_port = board_port
+
+    main_directory_name = File.basename(@sketch_file_path).split('.').first.underscore
+    main_directory = File.join(@root_directory, main_directory_name) 
+    build_directory = File.join(main_directory, "build")    
+    @arduino_cmake_build = ArduinoSketchBuilder::ArduinoCmakeBuild.new(main_directory, build_directory)
+  end
+
+  def state
+    @arduino_cmake_build.state
+  end
+
+  def message
+    @arduino_cmake_build.message
+  end
+
+  def setup_sketch
+    ArduinoSketchBuilder::Setup.new.setup(@root_directory, @sketch_file_path, board_type: @board_type, board_port: @board_port)
+  end
+
+  def build_and_upload
+    @arduino_cmake_build.build_and_upload
+  end
+
+  def reset
+    @arduino_cmake_build.reset
+  end
+
+end

data/lib/arduino_sketch_builder/setup.rb

@@ -6,7 +6,7 @@ class ArduinoSketchBuilder::Setup
   ARDUINO_CMAKE_DIRECTORY = File.expand_path('../../../arduino-cmake', __FILE__)
   TEMPLATES_DIRECTORY = File.expand_path('../../../templates', __FILE__)
 
-  def configure(root_directory)
+  def self.configure(root_directory)
 
     FileUtils.cp_r(File.join(ARDUINO_CMAKE_DIRECTORY, 'cmake'), root_directory)
 

data/lib/arduino_sketch_builder/version.rb

@@ -1,3 +1,3 @@
 module ArduinoSketchBuilder
-  VERSION = "0.0.7"
+  VERSION = "0.1.0"
 end

data/lib/arduino_sketch_builder.rb

@@ -2,6 +2,7 @@ require "arduino_sketch_builder/version"
 require "arduino_sketch_builder/arduino_cmake_build"
 require "arduino_sketch_builder/c_make_lists_file_generator"
 require "arduino_sketch_builder/setup"
+require "arduino_sketch_builder/base"
 
 module ArduinoSketchBuilder
   # Your code goes here...

data/spec/arduino_sketch_builder/arduino_cmake_build_spec.rb

@@ -2,8 +2,8 @@ require 'spec_helper'
 
 describe ArduinoSketchBuilder::ArduinoCmakeBuild do
 
-  MAIN_DIRECTORY = File.expand_path('../../arduino_sketches_fixture', __FILE__)
-  BUILD_DIRECTORY = "#{MAIN_DIRECTORY}/build"
+  MAIN_DIRECTORY = ARDUINO_SKETCHES_FIXTURE_DIRECTORY
+  BUILD_DIRECTORY = File.join(MAIN_DIRECTORY, "build")
 
   before(:each) do
   	FileUtils.rm_rf(Dir.glob("#{BUILD_DIRECTORY}/*"))
@@ -110,9 +110,9 @@ describe ArduinoSketchBuilder::ArduinoCmakeBuild do
       File.exists?(File.join(BUILD_DIRECTORY, "Makefile")).should be_false
       File.exists?(File.join(BUILD_DIRECTORY, "src", "blink_customized_for_test.hex")).should be_false
 
-      @arduino_cmake_build.build_and_upload.should == :make_upload_complete
+      @arduino_cmake_build.build_and_upload.should == :complete
 
-      @arduino_cmake_build.state.should == :make_upload_complete 
+      @arduino_cmake_build.state.should == :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_true
@@ -121,4 +121,21 @@ describe ArduinoSketchBuilder::ArduinoCmakeBuild do
 
   end
 
+  context "reset" do
+
+    it "should clean up build directory and reset the state to :initial" do
+
+      @arduino_cmake_build.state.should == :initial
+      @arduino_cmake_build.cmake.should == :cmake_complete
+
+      File.exists?(File.join(BUILD_DIRECTORY, "Makefile")).should be_true
+
+      @arduino_cmake_build.reset.should == :initial
+
+      Dir.entries(BUILD_DIRECTORY).should == [".", "..", ".gitkeep"]
+
+    end
+
+  end
+
 end

data/spec/arduino_sketch_builder/base_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe ArduinoSketchBuilder::Base do
+
+  before(:each) do
+  	FileUtils.rm_rf(Dir.glob("#{TEMP_DIRECTORY}/*"))
+
+  	@root_directory = TEMP_DIRECTORY
+    ArduinoSketchBuilder::Setup.configure(@root_directory)
+
+    arduino_sketch_file_path = File.join(ARDUINO_SKETCHES_FIXTURE_DIRECTORY, 'src/BlinkCustomizedForTest/BlinkCustomizedForTest.ino')	
+    @build_directory = File.join(TEMP_DIRECTORY, "blink_customized_for_test", "build")
+    @arduino_sketch_builder = ArduinoSketchBuilder::Base.new(@root_directory, arduino_sketch_file_path)
+  end
+
+  it "should set up, build and upload Arduino sketch" do
+
+    @arduino_sketch_builder.setup_sketch
+    Dir.exists?(File.join(@root_directory, "blink_customized_for_test")).should be_true
+
+    @arduino_sketch_builder.state.should == :initial
+    File.exists?(File.join(@build_directory, "Makefile")).should be_false
+    File.exists?(File.join(@build_directory, "src", "blink_customized_for_test.hex")).should be_false
+
+    @arduino_sketch_builder.build_and_upload.should == :complete
+
+    @arduino_sketch_builder.state.should == :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_true
+
+  end
+
+end

data/spec/arduino_sketch_builder/setup_spec.rb

@@ -3,13 +3,11 @@ require 'spec_helper'
 describe ArduinoSketchBuilder::Setup do
 
   ARDUINO_CMAKE_DIRECTORY = File.expand_path('../../../arduino-cmake', __FILE__)
-  ARDUINO_SKETCHES_FIXTURE_DIRECTORY = File.expand_path('../../arduino_sketches_fixture', __FILE__)
-  ARDUINO_SKETCH_FILE_PATH = File.expand_path(File.join(ARDUINO_SKETCHES_FIXTURE_DIRECTORY, 'src/BlinkCustomizedForTest/BlinkCustomizedForTest.ino'), __FILE__)
+  ARDUINO_SKETCH_FILE_PATH = File.join(ARDUINO_SKETCHES_FIXTURE_DIRECTORY, 'src/BlinkCustomizedForTest/BlinkCustomizedForTest.ino')
   TEMPLATES_DIRECTORY = File.expand_path('../../../templates', __FILE__)
 
   before(:each) do
   	FileUtils.rm_rf(Dir.glob("#{TEMP_DIRECTORY}/*"))
-    @setup = ArduinoSketchBuilder::Setup.new
   end
 
   context "configure" do
@@ -18,7 +16,7 @@ describe ArduinoSketchBuilder::Setup do
 
       root_directory = TEMP_DIRECTORY
 
-      @setup.configure(root_directory)
+      ArduinoSketchBuilder::Setup.configure(root_directory)
 
       Dir.exists?(File.join(root_directory, "cmake")).should be_true 
       File.exists?(File.join(root_directory, "cmake", "ArduinoToolchain.cmake")).should be_true
@@ -34,7 +32,7 @@ describe ArduinoSketchBuilder::Setup do
 
       root_directory = TEMP_DIRECTORY
 
-      @setup.configure(root_directory)
+      ArduinoSketchBuilder::Setup.configure(root_directory)
 
       Dir.exists?(File.join(root_directory, "libraries")).should be_true 
       File.exists?(File.join(root_directory, "libraries", ".gitkeep")).should be_true
@@ -45,7 +43,7 @@ describe ArduinoSketchBuilder::Setup do
 
       root_directory = TEMP_DIRECTORY
 
-      @setup.configure(root_directory)
+      ArduinoSketchBuilder::Setup.configure(root_directory)
 
       File.exists?(File.join(root_directory, ".gitignore")).should be_true
       File.read(File.join(root_directory, ".gitignore")).should == File.read(File.join(TEMPLATES_DIRECTORY, "root_gitignore_template"))                
@@ -56,6 +54,10 @@ describe ArduinoSketchBuilder::Setup do
 
   context "setup" do
 
+    before(:each) do
+      @setup = ArduinoSketchBuilder::Setup.new
+    end    
+
     it "should create a directory structure for an Arduino sketch" do
 
       root_directory = TEMP_DIRECTORY

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ require 'arduino_sketch_builder'
 
 FIXTURES_DIRECTORY = File.expand_path('../fixtures', __FILE__)
 TEMP_DIRECTORY = File.expand_path('../temp', __FILE__)
+ARDUINO_SKETCHES_FIXTURE_DIRECTORY = File.expand_path('../arduino_sketches_fixture', __FILE__)
 
 RSpec.configure do |config|
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arduino_sketch_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors:
 - Tadatoshi Takahashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-05 00:00:00.000000000 Z
+date: 2013-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -56,6 +56,7 @@ files:
 - arduino_sketch_builder.gemspec
 - lib/arduino_sketch_builder.rb
 - lib/arduino_sketch_builder/arduino_cmake_build.rb
+- lib/arduino_sketch_builder/base.rb
 - lib/arduino_sketch_builder/c_make_lists_file_generator.rb
 - lib/arduino_sketch_builder/setup.rb
 - lib/arduino_sketch_builder/version.rb
@@ -63,6 +64,7 @@ files:
 - lib/arduino_sketches/src/BlinkCustomized/BlinkCustomized.ino
 - lib/arduino_sketches/src/CMakeLists.txt
 - spec/arduino_sketch_builder/arduino_cmake_build_spec.rb
+- spec/arduino_sketch_builder/base_spec.rb
 - spec/arduino_sketch_builder/c_make_lists_file_generator_spec.rb
 - spec/arduino_sketch_builder/setup_spec.rb
 - spec/arduino_sketches_fixture/CMakeLists.txt
@@ -105,6 +107,7 @@ summary: Performs calling the code to compile Arduino sketch and upload it to Ar
   by Ruby, instead of using Arduino IDE.
 test_files:
 - spec/arduino_sketch_builder/arduino_cmake_build_spec.rb
+- spec/arduino_sketch_builder/base_spec.rb
 - spec/arduino_sketch_builder/c_make_lists_file_generator_spec.rb
 - spec/arduino_sketch_builder/setup_spec.rb
 - spec/arduino_sketches_fixture/CMakeLists.txt