brewby-cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a730c58cd6decfcabe608df7bfc0d01634ab1c10
+  data.tar.gz: 724b8d2e0034ea369f119474dec401e1eb9dba12
+SHA512:
+  metadata.gz: 8b0657a1ae18d35cf2be935ef5edec1ddefdca5a6b517414968e9e04101eadf7a2278647b150120246a00453ca743d6e66393cc2ea7ff1afbfc8bda0eca5242e
+  data.tar.gz: 07715b81743ed36187d42be9a89099483f2eef694385f816ac590fbc22f5e864feba61be0352b57d0b5acd9e936993ae34ecfb9ff519739df7373858fa480cfb

data/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_BIN: bin

data/.gitignore

@@ -0,0 +1 @@
+bin

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    brewby-cli (0.1.0)
+      brewby (~> 0.1.1)
+      ffi-ncurses
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    brewby (0.1.1)
+      temper-control
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    ffi (1.9.3)
+    ffi-locale (1.0.1)
+      ffi (>= 1.0.9)
+    ffi-ncurses (0.4.0)
+      ffi (>= 1.0.9)
+      ffi-locale (>= 1.0.0)
+    method_source (0.8.2)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    slop (3.4.7)
+    temper-control (0.0.1)
+    thor (0.18.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  brewby-cli!
+  pry
+  rspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrew Nordman
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,22 @@
+# brewby-cli
+
+An ncurses-based terminal application for the Brewby ecosystem.
+
+![screenshot](http://f.cl.ly/items/301C0o071J0y0i010x1v/cli-screenshot.png)
+
+## Install
+
+Brewby CLI is released as a gem on rubygems.  `gem install brewby-cli`
+
+## Usage
+
+Brewby CLI currently responds to the 'start' command only.  When run by itself, it loads your
+equipment configuration and begins a `TempControl` step in manual power mode at 0% power.
+
+When passing a Brewby Recipe file via `--recipe FILE`, it loads the equipment configuration, parses the recipe file,
+and starts the first step in the recipe.
+
+By default, Brewby CLI looks for an equipment configuration file at `~/.brewbyrc`, detailing the
+IO adapters and names.  These names map to the recipe file.  To specify a different file for
+equipment loading, pass the `--config CONFIG` flag.
+

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require 'bundler/setup'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/brewby-cli.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.authors       = ["Andrew Nordman"]
+  gem.email         = ["cadwallion@gmail.com"]
+  gem.summary       = %q{An ncurses-based terminal application for the Brewby ecosystem}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = ['brewby']
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "brewby-cli"
+  gem.require_paths = ["lib"]
+  gem.version       = "0.1.0"
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'pry'
+  gem.add_dependency 'thor'
+  gem.add_dependency 'ffi-ncurses'
+  gem.add_dependency 'brewby', '~>0.1.1'
+end

data/examples/brewby_recipe.rb

@@ -0,0 +1,35 @@
+recipe 'Honey Ale' do
+  step 'Strike Water' do
+    type :temp_control
+    mode :auto
+    target 168.0
+    hold_duration 5
+    input :hlt
+    output :hlt
+  end
+
+  step 'Infusion Mash Step' do
+    type :temp_control
+    mode :auto
+    target 150.0
+    hold_duration 60
+    input :mlt
+    output :hlt
+  end
+
+  step 'Fly Sparge' do
+    type :temp_control
+    mode :auto
+    target 168.0
+    hold_duration 45
+    input :hlt
+    output :hlt
+  end
+
+  step 'Boil' do
+    type :temp_control
+    mode :manual
+    input :bk
+    output :bk
+  end
+end

data/examples/example_brewbyrc

@@ -0,0 +1,12 @@
+{
+  "adapter":"raspberry_pi",
+  "inputs":[
+    { "name":"mlt", "hardware_id":"28-12345" },
+    { "name":"hlt", "hardware_id":"28-67891" },
+    { "name":"bk",  "hardware_id":"28-01983" }
+  ],
+  "outputs":[
+    { "pin":17, "name":"hlt" },
+    { "pin":19, "name": "bk" }
+  ]
+}

data/lib/brewby/cli.rb

@@ -0,0 +1,2 @@
+require 'brewby/cli/application'
+require 'brewby/cli/view'

data/lib/brewby/cli/application.rb

@@ -0,0 +1,36 @@
+require 'brewby'
+require 'brewby/cli/views/application'
+
+module Brewby
+  module CLI
+    class Application < Brewby::Application
+      attr_accessor :ready
+      attr_reader :view
+      def initialize options = {}
+        super  
+        configure_view
+      end
+
+      def configure_view
+        @view = Brewby::CLI::Views::Application.new self
+      end
+
+      def start
+        super
+      ensure
+        view.clear if view
+      end
+
+      def start_step step
+        super 
+        view.load_step_view step
+      end
+
+      def tick
+        super
+        view.render
+        view.handle_input
+      end
+    end
+  end
+end

data/lib/brewby/cli/view.rb

@@ -0,0 +1,24 @@
+require 'ffi-ncurses'
+require 'brewby/cli/views/application'
+require 'brewby/cli/views/temp_control'
+
+module Brewby
+  module CLI
+    class View
+      include FFI::NCurses
+
+      def initialize
+        initscr
+        cbreak
+        noecho
+        timeout(100)
+        curs_set 0
+        counter = 0
+      end
+
+      def clear
+        endwin
+      end
+    end
+  end
+end

data/lib/brewby/cli/views/application.rb

@@ -0,0 +1,63 @@
+require 'brewby/cli/view'
+
+module Brewby
+  module CLI
+    module Views
+      class Application
+        attr_reader :view, :step_view, :app
+        def initialize app
+          @app = app
+          @view = load_parent_view
+        end
+
+        def load_parent_view
+          Brewby::CLI::View.new
+        end
+
+        def current_step_index
+          app.steps.index(app.current_step)+1
+        end
+
+        def step_count
+          app.steps.size
+        end
+
+        def brew_timer
+          app.timer_for(app.elapsed.to_i)
+        end
+
+        def render
+          load_step_view app.current_step unless step_view
+          view.move 1, 0
+          view.addstr "BREWBY: Brewing '#{app.name}'" if app.name
+          view.move 2, 0
+          view.addstr "Step #{current_step_index}/#{step_count}: "
+          view.move 16, 0
+          view.addstr "Brew Timer: #{brew_timer}"
+          view.refresh
+          step_view.render
+        end
+
+        def handle_input
+          if (char = view.getch) == 'q'[0].ord
+            exit
+          elsif char == 'n'[0].ord
+            app.current_step.stop_timer
+            app.ready = true
+          else
+            step_view.handle_input char
+          end
+        end
+
+        def load_step_view step
+          step_class_name = step.class.name.split("::").last
+          @step_view = Brewby::CLI::Views.const_get(step_class_name).new step, view
+        end
+
+        def clear
+          view.clear
+        end
+      end
+    end
+  end
+end

data/lib/brewby/cli/views/temp_control.rb

@@ -0,0 +1,71 @@
+module Brewby
+  module CLI
+    module Views
+      class TempControl
+        attr_reader :step, :view
+        def initialize step, view
+          @step = step
+          @view = view
+        end
+
+        def power_level
+          (step.power_level * 100.0).round(3)
+        end
+
+        def timer
+          step.timer_for(step.elapsed.to_i)
+        end
+
+        def time_remaining
+          step.countdown_for(step.time_remaining)
+        end
+
+        def render
+          view.move 2, 10
+          if step.name
+            view.addstr step.name.ljust(70)
+          else
+            view.addstr "#{step.mode.capitalize} Temp Control".ljust(70)
+          end
+
+          view.move 6, 0
+          view.addstr "Power Level: #{power_level}%".ljust(70)
+          view.move 16, 50
+          view.addstr "Step Timer: #{timer}"
+          view.refresh
+
+          if step.target
+            view.move 4, 0
+            view.addstr "Target Temp: #{step.target} F".ljust(70)
+          end
+
+          view.move 5, 0
+          view.addstr "Actual Temp: #{step.last_reading} F".ljust(25)
+
+          if step.threshold_reached
+            view.move 7, 0
+            view.addstr "Time Remaining: #{time_remaining}".ljust(70)
+          else
+            view.move 7, 0
+            view.addstr "".ljust(70)
+          end
+        end
+
+        def handle_input key
+          case key
+          when 'e'.ord
+            if step.mode == :manual
+              new_pct = [(step.power_level + 0.05).round(2), 1.0].min
+              step.set_power_level new_pct
+            end
+          when 'c'.ord
+            if step.mode == :manual
+              new_pct = [(step.power_level - 0.05).round(2), 0.0].max
+              step.set_power_level new_pct
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/application_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Brewby::CLI::Application do
+  before do
+    @output = {
+      pin: 1,
+      pulse_range: 5000
+    }
+    @view = Brewby::VirtualView.new
+    Brewby::CLI::Views::Application.any_instance.stub(:load_parent_view).and_return(@view)
+    @application = Brewby::CLI::Application.new adapter: :test, outputs: [@output], inputs: [{}]
+  end
+
+  context 'rendering' do
+    before do
+      @application.name = 'Awesome Ale'
+      @application.add_step :temp_control, mode: :auto, mode: :auto, target: 155.0, duration: 15, input: @application.inputs.last
+      @application.view.render
+    end
+
+    it 'renders the recipe name' do
+      line = @view.readline(1).strip
+      line.should == "BREWBY: Brewing 'Awesome Ale'"
+    end
+
+    it 'renders the step counter' do
+      line = @view.readline(2).strip
+      line.should == 'Step 1/1: Auto Temp Control'
+    end
+
+    it 'renders the brew timer' do
+      line = @view.readline(16).strip
+      line.should == 'Brew Timer: 00:00:00' + ''.ljust(30) + 'Step Timer: 00:00:00'
+    end
+  end
+
+  context 'input handling' do
+    it 'jumps to the next step when the n key is pressed' do
+      @view.stub(:getch).and_return('n'.ord)
+      @application.add_step :temp_control, mode: :auto, mode: :auto, target: 155.0, duration: 15, input: @application.inputs.last
+      @application.start_step @application.steps.first
+      @application.view.handle_input
+      @application.current_step.should be_ended
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'brewby/cli'
+require 'pry'
+
+load './spec/support/virtual_view.rb'

data/spec/support/sample_recipe.rb

@@ -0,0 +1,32 @@
+recipe 'Honey Ale' do
+  step 'Strike Water' do
+    type :temp_control
+    mode :auto
+    target 168.0
+    hold_duration 5
+    input :hlt
+    output :hlt
+  end
+
+  step 'Infusion Mash Step' do
+    type :temp_control, mode: :auto, target: 150.0, duration: 60
+    input :mlt
+    output :hlt
+  end
+
+  step 'Fly Sparge' do
+    type :temp_control
+    mode :auto
+    target 168.0
+    hold_duration 45
+    input :hlt
+    output :mlt
+  end
+
+  step 'Boil' do
+    type :temp_control
+    mode :manual
+    input :bk
+    output :bk
+  end
+end

data/spec/support/virtual_view.rb

@@ -0,0 +1,31 @@
+require 'stringio'
+
+module Brewby
+  class VirtualView
+    def initialize
+      @output = []
+    end
+
+    def move row, col
+      @output[row] ||= StringIO.new("".ljust(70))
+      @output[row].pos = col
+      @current_row = row
+    end
+
+    def addstr string
+      @output[@current_row].write string
+    end
+
+    def readline lineno
+      @output[lineno].string
+    end
+
+    def refresh
+      # no-op
+    end
+
+    def getch
+      # no-op. this will get stubbed by a test
+    end
+  end
+end

data/spec/temp_control_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe Brewby::CLI::Views::TempControl do
+  let(:sensor) { Brewby::TempSensor.new 1 }
+  let(:adapter) { Brewby::Outputs::Test.new }
+  let(:element) { Brewby::HeatingElement.new adapter, pulse_width: 5000 }
+  let(:step) { Brewby::Steps::TempControl.new mode: :manual, input: sensor, output: element }
+  let(:view) { Brewby::VirtualView.new }
+  let(:step_view) { Brewby::CLI::Views::TempControl.new step, view }
+
+  describe 'rendering' do
+    let(:step) { Brewby::Steps::TempControl.new mode: :auto, target: 152.0, input: sensor, output: element }
+
+    before do
+      step.instance_variable_set(:@last_reading, 100.0)
+      step_view.render
+    end
+
+    it 'renders the default name of the step' do
+      line = view.readline(2).strip
+      line.should == "Auto Temp Control"
+    end
+
+    it 'renders the actual temperature' do
+      line = view.readline(5).strip
+      line.should == "Actual Temp: 100.0 F"
+    end
+
+    it 'renders the target temperature' do
+      line = view.readline(4).strip
+      line.should == "Target Temp: 152.0 F"
+    end
+
+    it 'renders the current power level' do
+      line = view.readline(6).strip
+      line.should == "Power Level: 0.0%"
+    end
+
+    it 'renders the step timer' do
+      line = view.readline(16).strip
+      line.should == "Step Timer: 00:00:00"
+    end
+  end
+
+  describe 'input handling' do
+    context 'in manual mode' do
+      it 'increases power level by 5% when e key is pressed' do
+        step.set_power_level 0.95
+        step_view.handle_input('e'.ord)
+        step.power_level.should == 1.0
+      end
+
+      it 'decreases power level by 5% when c key is pressed' do
+        step.set_power_level 0.85
+        step_view.handle_input('c'.ord)
+        step.power_level.should == 0.80
+      end
+    end
+
+    context 'in auto mode' do
+      let(:step) { Brewby::Steps::TempControl.new mode: :auto, target: 150.0, 
+        input: sensor, output: element }
+
+      it 'does nothing when e key is pressed' do
+        step.set_power_level 0.80
+        step_view.handle_input('e'.ord)
+        step.power_level.should == 0.80 
+      end
+
+      it 'does nothing when c key is pressed' do
+        step.set_power_level 0.80
+        step_view.handle_input('c'.ord)
+        step.power_level.should == 0.80
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: brewby-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Nordman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ffi-ncurses
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: brewby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+description: 
+email:
+- cadwallion@gmail.com
+executables:
+- brewby
+extensions: []
+extra_rdoc_files: []
+files:
+- .bundle/config
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/autospec
+- bin/brewby
+- bin/htmldiff
+- bin/ldiff
+- bin/rspec
+- brewby-cli.gemspec
+- examples/brewby_recipe.rb
+- examples/example_brewbyrc
+- lib/brewby/cli.rb
+- lib/brewby/cli/application.rb
+- lib/brewby/cli/view.rb
+- lib/brewby/cli/views/application.rb
+- lib/brewby/cli/views/temp_control.rb
+- spec/application_spec.rb
+- spec/spec_helper.rb
+- spec/support/sample_recipe.rb
+- spec/support/virtual_view.rb
+- spec/temp_control_spec.rb
+homepage: ''
+licenses: []
+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.0.14
+signing_key: 
+specification_version: 4
+summary: An ncurses-based terminal application for the Brewby ecosystem
+test_files:
+- spec/application_spec.rb
+- spec/spec_helper.rb
+- spec/support/sample_recipe.rb
+- spec/support/virtual_view.rb
+- spec/temp_control_spec.rb