workshop 0.0.1

data/spec/builder_spec.rb

@@ -0,0 +1,159 @@
+require 'spec_helper'
+
+describe Workshop::Builder do
+  let(:project_name) {'foo'}
+  let(:main_filename) {nil}
+  let(:arduino_hardware_directory) {'/app/hardware'}
+  let(:arduino_variant_directory) {'/app/hardware/variants/standard'}
+  let(:arduino_core_directory) {'/app/hardware/cores/arduino'}
+  let(:source_directory) {'/app/src'}
+  let(:build_directory) {'/app/build'}
+  let(:build_mcu) {'atmega32u4'}
+  let(:build_f_cpu) {'16000000L'}
+  let(:build_vid) {'0x0000'}
+  let(:build_pid) {'0x0001'}
+  let(:build_arduino) {'111'}
+  let(:project) do
+    double(:project).tap do |project|
+      project.stub(:arduino_hardware_directory).and_return(arduino_hardware_directory)
+      project.stub(:arduino_core_directory).and_return(arduino_core_directory)
+      project.stub(:arduino_variant_directory).and_return(arduino_variant_directory)
+      project.stub(:source_directory).and_return(source_directory)
+      project.stub(:build_directory).and_return(build_directory)
+      project.stub(:build_mcu).and_return(build_mcu)
+      project.stub(:build_f_cpu).and_return(build_f_cpu)
+      project.stub(:build_vid).and_return(build_vid)
+      project.stub(:build_pid).and_return(build_pid)
+      project.stub(:build_arduino).and_return(build_arduino)
+      project.stub(:name).and_return(project_name)
+      project.stub(:main_filename).and_return(main_filename)
+      project.stub(:includes).and_return([])
+    end
+  end
+  subject do
+    Workshop::Builder.new(project).tap do |builder|
+      Dir.stub(:[]).with("#{arduino_core_directory}/**/*.c").and_return([
+        "#{arduino_core_directory}/core.c"])
+      Dir.stub(:[]).with("#{arduino_core_directory}/**/*.cpp").and_return([
+        "#{arduino_core_directory}/core.cpp"])
+      Dir.stub(:[]).with("#{arduino_variant_directory}/**/*.c").and_return([
+        "#{arduino_variant_directory}/variant.c"])
+      Dir.stub(:[]).with("#{arduino_variant_directory}/**/*.cpp").and_return([
+        "#{arduino_variant_directory}/variant.cpp"])
+      Dir.stub(:[]).with("#{source_directory}/**/*.c").and_return([
+        "#{source_directory}/app.c"])
+      Dir.stub(:[]).with("#{source_directory}/**/*.cpp").and_return([
+        "#{source_directory}/app.cpp"])
+    end
+  end
+
+  describe '#core_files' do
+    it 'it returns the c and cpp files in the "arduino" core directory' do
+      files = subject.core_files
+      expect(files).to eq(['/app/hardware/cores/arduino/core.c',
+                            '/app/hardware/cores/arduino/core.cpp'])
+    end
+  end
+
+  describe '#variant_files' do
+    it 'it returns the c and cpp files in the "standard" variant directory' do
+      files = subject.variant_files
+      expect(files).to eq(['/app/hardware/variants/standard/variant.c',
+                            '/app/hardware/variants/standard/variant.cpp'])
+    end
+  end
+
+  describe '#source_files' do
+    it 'it returns the c and cpp files in the project source directory' do
+      files = subject.source_files
+      expect(files).to eq(['/app/src/app.c', '/app/src/app.cpp'])
+    end
+  end
+
+  describe '#output_file' do
+    it 'for "/app/src/foo.c" it returns "/app/build/foo.c.o"' do
+      output = subject.output_file('/app/src/foo.c')
+      expect(output).to eq('/app/build/foo.c.o')
+    end
+  end
+
+  describe '#o_files_to_archive' do
+    context 'project name is the same as the main output file' do
+      let(:project_name) {'foo'}
+      it 'the *.o files to archive do not include the "foo.cpp.o" file' do
+        files = subject.o_files_to_archive
+        expect(files).to_not include('/app/build/foo.cpp.o')
+      end
+    end
+  end
+
+  describe '#compiler_flags' do
+    context 'build options have values' do
+      it 'returns the correct compiler flags for a *.c file' do
+        flags = subject.compiler_flags
+        expect(flags).to include('-c')
+        expect(flags).to include('-g')
+        expect(flags).to include('-Os')
+        expect(flags).to include('-Wall')
+        expect(flags).to include('-fno-exceptions')
+        expect(flags).to include('-ffunction-sections')
+        expect(flags).to include('-fdata-sections')
+        expect(flags).to include('-mmcu=atmega32u4')
+        expect(flags).to include('-DF_CPU=16000000L')
+        expect(flags).to include('-MMD')
+        expect(flags).to include('-DUSB_VID=0x0000')
+        expect(flags).to include('-DUSB_PID=0x0001')
+        expect(flags).to include('-DARDUINO=111')
+      end
+    end
+
+    context 'build options are nil' do
+      let(:build_mcu) {nil}
+      let(:build_f_cpu) {nil}
+      let(:build_vid) {nil}
+      let(:build_pid) {nil}
+      let(:build_arduino) {nil}
+      it 'returns the correct compiler flags for a *.c file' do
+        flags = subject.compiler_flags
+        expect(flags).to include('-c')
+        expect(flags).to include('-g')
+        expect(flags).to include('-Os')
+        expect(flags).to include('-Wall')
+        expect(flags).to include('-fno-exceptions')
+        expect(flags).to include('-ffunction-sections')
+        expect(flags).to include('-fdata-sections')
+        expect(flags).to_not include('-mmcu=')
+        expect(flags).to_not include('-DF_CPU=')
+        expect(flags).to include('-MMD')
+        expect(flags).to_not include('-DUSB_VID=')
+        expect(flags).to_not include('-DUSB_PID=')
+        expect(flags).to_not include('-DARDUINO=')
+      end
+    end
+  end
+
+  describe '#compile_command_for' do
+    it 'constructs a avr-gcc compile command for a *.c file' do
+      command = subject.compile_command_for('/app/src/foo.c')
+      expect(command).to include('/app/hardware/tools/avr/bin/avr-gcc')
+      expect(command).to include('-c')
+      expect(command).to include('-g')
+      expect(command).to include('-Os')
+      expect(command).to include('-Wall')
+      expect(command).to include('-fno-exceptions')
+      expect(command).to include('-ffunction-sections')
+      expect(command).to include('-fdata-sections')
+      expect(command).to include('-mmcu=atmega32u4')
+      expect(command).to include('-DF_CPU=16000000L')
+      expect(command).to include('-MMD')
+      expect(command).to include('-DUSB_VID=0x0000')
+      expect(command).to include('-DUSB_PID=0x0001')
+      expect(command).to include('-DARDUINO=111')
+      expect(command).to include('/app/src/foo.c')
+      expect(command).to include('-I/app/hardware/cores/arduino')
+      expect(command).to include('-I/app/hardware/variants/standard')
+      expect(command).to include('-o /app/build/foo.c.o')
+    end
+  end
+
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Workshop::Project::Configuration do
+  describe '#arduino_app_directory' do
+    it 'defaults arduino app directory to standard OS X app location' do
+      config = Workshop::Project::Configuration.new
+      expect(config.arduino_app_directory).to eq('/Applications/Arduino.app')
+    end
+  end
+
+  describe '#project_name' do
+    it 'defaults project name to be the lowercased and underscored folder name' do
+      Workshop::Project::Configuration.any_instance.stub(:app_directory).and_return('/a/Foo Bar')
+      config = Workshop::Project::Configuration.new
+      expect(config.project_name).to eq('foo_bar')
+    end
+  end
+
+  describe '#app_directory' do
+    it 'returns current working directory for app directory' do
+      Dir.stub(:pwd).and_return('/foo/bar')
+      config = Workshop::Project::Configuration.new
+      expect(config.app_directory).to eq('/foo/bar')
+    end
+  end
+
+  describe '#build' do
+    it 'initialized with an instance of a build configuration' do
+      expect(subject.build.class).to eq(Workshop::Project::Configuration::Build)
+    end
+  end
+
+  describe '#upload' do
+    it 'initialized with an instance of an upload configuration' do
+      expect(subject.upload.class).to eq(Workshop::Project::Configuration::Upload)
+    end
+  end
+end

data/spec/project_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Workshop::Project do
+  let(:arduino) do
+    double(:arduino).tap do |arduino|
+      arduino.stub(:hardware_directory).and_return('/hardware')
+    end
+  end
+
+  subject do
+    Workshop::Project.configure { |config| }.tap do |project|
+      project.stub(:arduino).and_return(arduino)
+    end
+  end
+
+  describe 'configure' do
+    it 'passes a configure parameter' do
+      Workshop::Project.configure do |config|
+        expect(config.class).to eq(Workshop::Project::Configuration)
+      end
+    end
+  end
+
+  describe '#arduino_hardware_directory' do
+    it 'returns the arduino configs hardware directory' do
+      expect(subject.arduino_hardware_directory).to eq('/hardware')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'workshop'
+
+RSpec.configure do |config|
+
+end

data/spec/tools_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Workshop::Tools do
+  context 'arduino hardware directory is "/app/hardware"' do
+    let(:hardware_directory) { '/app/hardware' }
+    subject { Workshop::Tools.new hardware_directory }
+
+    describe '#tools_directory' do
+      it 'returns "/app/hardware/tools"' do
+        expect(subject.tools_directory).to eq('/app/hardware/tools')
+      end
+    end
+
+    describe '#avr_gcc' do
+      it 'returns "/app/hardware/tools/avr-gcc"' do
+        expect(subject.avr_gcc).to eq('/app/hardware/tools/avr/bin/avr-gcc')
+      end
+    end
+
+    describe '#compiler' do
+      it 'returns "avr-gcc" for a *.c file' do
+        compiler = subject.compiler('/app/src/foo.c')
+        expect(compiler).to eq('/app/hardware/tools/avr/bin/avr-gcc')
+      end
+
+      it 'returns "avr-g++" for a *.cpp file' do
+        compiler = subject.compiler('/app/src/foo.cpp')
+        expect(compiler).to eq('/app/hardware/tools/avr/bin/avr-g++')
+      end
+    end
+
+  end
+end

data/spec/upload_configuration_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Workshop::Project::Configuration::Upload do
+  describe '#protocol' do
+    it 'returns "stk500" as the default protocol' do
+      expect(subject.protocol).to eq('stk500')
+    end
+  end
+end

data/workshop.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'workshop/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "workshop"
+  spec.version       = Workshop::VERSION
+  spec.authors       = ["Chase McCarthy"]
+  spec.email         = ["chase@code0100fun.com"]
+  spec.summary       = %q{A project managment toolset for the Arduino platform.}
+  spec.description   = %q{An Arduino project build system designed to make Arduino development more fun and less... crappy.}
+  spec.homepage      = "https://github.com/code0100fun/workshop"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.bindir        = 'bin'
+  spec.executables   = ['workshop']
+
+  spec.add_dependency "activesupport", "~>4.1"
+  spec.add_dependency "thor", "~>0.19"
+  spec.add_dependency "colorize", "~>0.7"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "pry", "~>0.9"
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: workshop
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chase McCarthy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: An Arduino project build system designed to make Arduino development
+  more fun and less... crappy.
+email:
+- chase@code0100fun.com
+executables:
+- workshop
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/workshop
+- examples/blink/Rakefile
+- examples/blink/config/com_port.yml
+- examples/blink/src/blink.cpp
+- lib/workshop.rb
+- lib/workshop/arduino.rb
+- lib/workshop/builder.rb
+- lib/workshop/cli.rb
+- lib/workshop/project.rb
+- lib/workshop/project/configuration.rb
+- lib/workshop/project/configuration/build.rb
+- lib/workshop/project/configuration/upload.rb
+- lib/workshop/project/setup.rb
+- lib/workshop/tasks.rb
+- lib/workshop/templates/Rakefile.erb
+- lib/workshop/templates/blink.cpp
+- lib/workshop/tools.rb
+- lib/workshop/uploader.rb
+- lib/workshop/version.rb
+- spec/arduino_spec.rb
+- spec/build_configuration_spec.rb
+- spec/builder_spec.rb
+- spec/configuration_spec.rb
+- spec/project_spec.rb
+- spec/spec_helper.rb
+- spec/tools_spec.rb
+- spec/upload_configuration_spec.rb
+- workshop.gemspec
+homepage: https://github.com/code0100fun/workshop
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A project managment toolset for the Arduino platform.
+test_files:
+- spec/arduino_spec.rb
+- spec/build_configuration_spec.rb
+- spec/builder_spec.rb
+- spec/configuration_spec.rb
+- spec/project_spec.rb
+- spec/spec_helper.rb
+- spec/tools_spec.rb
+- spec/upload_configuration_spec.rb