arduino_sketch_builder 0.0.2

data/arduino_sketch_builder.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'arduino_sketch_builder/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "arduino_sketch_builder"
+  gem.version       = ArduinoSketchBuilder::VERSION
+  gem.authors       = ["Tadatoshi Takahashi"]
+  gem.email         = ["tadatoshi@gmail.com"]
+  gem.description   = %q{Builds Arduino sketch}
+  gem.summary       = %q{Performs calling the code to compile Arduino sketch and upload it to Arduino by Ruby, instead of using Arduino IDE.}
+  gem.homepage      = "https://github.com/tadatoshi/arduino_sketch_builder"
+
+  gem.files         = `git ls-files`.split($/)
+  # gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "activesupport"
+  gem.add_development_dependency "rspec"  
+end

data/lib/arduino_sketch_builder.rb

@@ -0,0 +1,8 @@
+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"
+
+module ArduinoSketchBuilder
+  # Your code goes here...
+end

data/lib/arduino_sketch_builder/arduino_cmake_build.rb

@@ -0,0 +1,52 @@
+require "open3"
+
+class ArduinoSketchBuilder::ArduinoCmakeBuild
+
+  State = Struct.new(:value, :message)
+
+  INITIAL = State.new(:initial, "ready") 
+  CMAKE_COMPLETE = State.new(:cmake_complete, "success") 
+  MAKE_COMPLETE = State.new(:make_complete, "success")
+  MAKE_UPLOAD_COMPLETE = State.new(:make_upload_complete, "success")
+
+  STATE_SEQUENCE = [INITIAL, CMAKE_COMPLETE, MAKE_COMPLETE, MAKE_UPLOAD_COMPLETE]
+
+  def initialize
+    @state = INITIAL
+  end
+
+  def state
+    @state.value
+  end
+
+  def message
+    @state.message
+  end
+
+  [:cmake, :make, :make_upload].each_with_index do |method_name, index|
+    
+    define_method(method_name) do |build_directory, main_directory=nil|
+
+      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)
+
+      Open3.popen3("#{method_name.to_s.sub('_',' ')} #{main_directory ? main_directory : ''}") do |stdin, stdout, stderr, wait_thread|
+        pid = wait_thread.pid
+        exit_status = wait_thread.value
+        if exit_status.success?
+          @state = STATE_SEQUENCE[index+1]
+        else
+          @state = State.new("#{method_name}_incomplete".to_sym, stderr.gets)
+        end
+      end
+
+      self.state
+
+    end
+
+  end
+
+end

data/lib/arduino_sketch_builder/c_make_lists_file_generator.rb

@@ -0,0 +1,34 @@
+require 'active_support/core_ext/string/inflections'
+
+class ArduinoSketchBuilder::CMakeListsFileGenerator
+
+  TEMPLATES_DIRECTORY = File.expand_path('../../../templates', __FILE__)	
+
+  attr_reader :root_directory
+  attr_reader :sketch_name
+
+  def generate_main(root_directory, c_make_lists_file_directory)
+
+    @root_directory = root_directory
+
+    erb = ERB.new(File.read("#{TEMPLATES_DIRECTORY}/MainCMakeListsTemplate.txt.erb"))
+
+    generated_content = erb.result(binding)
+
+    File.write(File.join(c_make_lists_file_directory, "CMakeLists.txt"), generated_content)    
+
+  end
+
+  def generate_sketch_specific(sketch_name, c_make_lists_file_directory)
+
+  	@sketch_name = sketch_name
+
+    erb = ERB.new(File.read("#{TEMPLATES_DIRECTORY}/SourceCMakeListsTemplate.txt.erb"))
+
+    generated_content = erb.result(binding)
+
+    File.write(File.join(c_make_lists_file_directory, "CMakeLists.txt"), generated_content)
+
+  end
+
+end

data/lib/arduino_sketch_builder/setup.rb

@@ -0,0 +1,46 @@
+require 'active_support/core_ext/string/inflections'
+
+class ArduinoSketchBuilder::Setup
+
+  ARDUINO_CMAKE_DIRECTORY = File.expand_path('../../../arduino-cmake', __FILE__)
+  TEMPLATES_DIRECTORY = File.expand_path('../../../templates', __FILE__)
+
+  def configure(root_directory)
+
+    FileUtils.cp_r(File.join(ARDUINO_CMAKE_DIRECTORY, 'cmake'), root_directory)
+
+    FileUtils.chmod_R('og-rwx', File.join(root_directory, 'cmake'))
+
+    FileUtils.mkdir_p(File.join(root_directory, 'libraries'))
+    FileUtils.cp(File.join(TEMPLATES_DIRECTORY, 'gitkeep_template'), File.join(root_directory, 'libraries', '.gitkeep'))
+
+    FileUtils.chmod_R('og-rwx', File.join(root_directory, 'libraries'))
+    FileUtils.chmod('og-rwx', File.join(root_directory, 'libraries', '.gitkeep'))
+
+    FileUtils.cp(File.join(TEMPLATES_DIRECTORY, 'root_gitignore_template'), File.join(root_directory, '.gitignore'))    
+    FileUtils.chmod('og-rwx', File.join(root_directory, '.gitignore'))
+
+  end
+
+  def setup(root_directory, sketch_file_path)
+
+    sketch_file_name = File.basename(sketch_file_path)
+  	sketch_name = sketch_file_name.split('.').first
+  	main_directory_name = sketch_name.underscore
+    
+    FileUtils.mkdir_p([File.join(root_directory, main_directory_name), 
+    	                 File.join(root_directory, main_directory_name, 'src'), 
+    	                 File.join(root_directory, main_directory_name, 'build'), 
+    	                 File.join(root_directory, main_directory_name, 'src', sketch_name)])
+
+    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'))
+
+    File.write(File.join(root_directory, main_directory_name, 'src', sketch_name, sketch_file_name), File.read(sketch_file_path))    
+
+    FileUtils.chmod_R('og-rwx', File.join(root_directory, main_directory_name))
+
+  end
+
+end

data/lib/arduino_sketch_builder/version.rb

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

data/lib/arduino_sketches/CMakeLists.txt

@@ -0,0 +1,20 @@
+#=============================================================================#
+# Author: Tadatoshi Takahashi                                                 #
+# Date:   30.01.2013                                                          #
+#                                                                             #
+# Description: Arduino CMake for arduino_sketch_builder                       #
+#                                                                             #
+#=============================================================================#
+set(CMAKE_TOOLCHAIN_FILE ../../arduino-cmake/cmake/ArduinoToolchain.cmake) # Arduino Toolchain
+
+
+cmake_minimum_required(VERSION 2.8)
+#====================================================================#
+#  Setup Project                                                     #
+#====================================================================#
+project(ArduinoSketchBuilder C CXX)
+
+print_board_list()
+print_programmer_list()
+
+add_subdirectory(src)   #add the src directory (lib/arduino_sketches/src) into build

data/lib/arduino_sketches/src/BlinkCustomized/BlinkCustomized.ino

@@ -0,0 +1,19 @@
+/*
+  BlinkCustomized
+  Turns on an LED on for two second, then off for two second, repeatedly.
+ 
+  This code is used for testing arduino_sketch_builder gem.
+ */
+
+void setup() {                
+  // initialize the digital pin as an output.
+  // Pin 13 has an LED connected on most Arduino boards:
+  pinMode(13, OUTPUT);     
+}
+
+void loop() {
+  digitalWrite(13, HIGH);   // set the LED on
+  delay(2000);              // wait for a second
+  digitalWrite(13, LOW);    // set the LED off
+  delay(2000);              // wait for a second
+}

data/lib/arduino_sketches/src/CMakeLists.txt

@@ -0,0 +1,14 @@
+# This configuration file outlines some of the ways Arduino CMake
+# can be used. For a detailed explenation of all the options please
+# reade README.rst.
+
+set(ARDUINO_DEFAULT_BOARD uno) # Default Board ID, when not specified
+set(ARDUINO_DEFAULT_PORT /dev/tty.usbmodem411) # Default Port, when not specified
+
+#====================================================================#
+# BlinkCustomized
+#====================================================================#
+generate_arduino_firmware(blink_customized
+    SKETCH BlinkCustomized
+    PROGRAMMER tadatoshi
+    NO_AUTOLIBS)

data/spec/arduino_sketch_builder/arduino_cmake_build_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+describe ArduinoSketchBuilder::ArduinoCmakeBuild do
+
+  MAIN_DIRECTORY = File.expand_path('../../arduino_sketches_fixture', __FILE__)
+  BUILD_DIRECTORY = "#{MAIN_DIRECTORY}/build"
+
+  before(:each) do
+  	FileUtils.rm_rf(Dir.glob("#{BUILD_DIRECTORY}/*"))
+    @arduino_cmake_build = ArduinoSketchBuilder::ArduinoCmakeBuild.new
+  end
+
+  after(:each) do
+    FileUtils.rm_rf(Dir.glob("#{BUILD_DIRECTORY}/*"))
+  end  
+
+  it "should execute cmake and make in sequence in build directory" 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.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.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.state.should == :make_upload_complete
+
+  end
+
+  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) }
+      .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) }
+      .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) }
+      .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) }
+      .to_not raise_error 
+
+  end
+
+  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) }
+      .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) }
+      .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) }
+      .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.state.should == :cmake_complete
+    expect { @arduino_cmake_build.make(BUILD_DIRECTORY) }
+      .to_not raise_error 
+
+  end  
+
+  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) }
+      .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) }
+      .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) }
+      .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.state.should == :make_complete
+    expect { @arduino_cmake_build.make_upload(BUILD_DIRECTORY) }
+      .to_not raise_error 
+
+  end    
+
+end

data/spec/arduino_sketch_builder/c_make_lists_file_generator_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe ArduinoSketchBuilder::CMakeListsFileGenerator do
+
+  FIXTURES_DIRECTORY = File.expand_path('../../fixtures', __FILE__)
+  TEMP_DIRECTORY = File.expand_path('../../temp', __FILE__)
+
+  before(:each) do
+  	FileUtils.rm_rf(Dir.glob("#{TEMP_DIRECTORY}/*"))
+    @c_make_lists_file_generator = ArduinoSketchBuilder::CMakeListsFileGenerator.new
+  end
+
+  it "should generate main CMakeLists.txt file" do
+
+    File.exists?(File.join(TEMP_DIRECTORY, "CMakeLists.txt")).should be_false
+
+    @c_make_lists_file_generator.generate_main("~/temp", 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, "MainCMakeLists.txt"))    
+
+  end
+
+  it "should generate CMakeLists.txt file for a given Arduino sketch name" 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
+
+end

data/spec/arduino_sketch_builder/setup_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe ArduinoSketchBuilder::Setup do
+
+  ARDUINO_CMAKE_DIRECTORY = File.expand_path('../../../arduino-cmake', __FILE__)
+  FIXTURES_DIRECTORY = File.expand_path('../../fixtures', __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__)
+  TEMPLATES_DIRECTORY = File.expand_path('../../../templates', __FILE__)
+  TEMP_DIRECTORY = File.expand_path('../../temp', __FILE__)
+
+  before(:each) do
+  	FileUtils.rm_rf(Dir.glob("#{TEMP_DIRECTORY}/*"))
+    @setup = ArduinoSketchBuilder::Setup.new
+  end
+
+  context "configure" do
+
+    it "should configure the root directory by putting cmake directory and its contents from arduino-cmake directory" do
+
+      root_directory = TEMP_DIRECTORY
+
+      @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
+      Dir.exists?(File.join(root_directory, "cmake", "Platform")).should be_true 
+      File.exists?(File.join(root_directory, "cmake", "Platform", "Arduino.cmake")).should be_true  
+      
+      File.read(File.join(root_directory, "cmake", "ArduinoToolchain.cmake")).should == File.read(File.join(ARDUINO_CMAKE_DIRECTORY, "cmake", "ArduinoToolchain.cmake"))    
+      File.read(File.join(root_directory, "cmake", "Platform", "Arduino.cmake")).should == File.read(File.join(ARDUINO_CMAKE_DIRECTORY, "cmake", "Platform", "Arduino.cmake"))    
+
+    end
+
+    it "should configure the root directory by putting libraries directory" do
+
+      root_directory = TEMP_DIRECTORY
+
+      @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
+
+    end 
+
+    it "should configure the root directory by putting .gitignore file" do
+
+      root_directory = TEMP_DIRECTORY
+
+      @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"))                
+
+    end   
+
+  end
+
+  context "setup" do
+
+    it "should create a directory structure for an Arduino sketch" do
+
+      root_directory = TEMP_DIRECTORY
+
+      @setup.setup(root_directory, ARDUINO_SKETCH_FILE_PATH)
+
+      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, "CMakeListsForTestSketch.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