brewer 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bec192aa1d499d22c0e81f2ac9567fd9bd3e8950
+  data.tar.gz: a7d307169606bd5d8cdd61a403596dcf5c0629b7
+SHA512:
+  metadata.gz: e5d98e1706031f25def1c3172bd58d255b31743c498bb1f66ca5f28a8aa519da039144fe77b5bc100e51a012616b45c3bffd6a04a12c84a5e9fc32983236327f
+  data.tar.gz: f71bb87645c0522889c0415579197b6404ba4fd587b27f8d5e4e4d3e042b96d4ecfa689c36d263dd17f00c455316d7acb6dfed12aec8e3a712a07aa723f512a7

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    brewer (0.0.10)
+      git (~> 1.3, >= 1.3.0)
+      ripl (~> 0.7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
+    bond (0.5.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    git (1.3.0)
+    json (2.0.3)
+    launchy (2.4.3)
+      addressable (~> 2.3)
+    public_suffix (2.0.4)
+    rake (12.0.0)
+    rdoc (5.1.0)
+    ripl (0.7.1)
+      bond (~> 0.5.1)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    simplecov (0.13.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  brewer!
+  launchy (~> 2.4, >= 2.4.0)
+  rake (~> 12.0, >= 12.0.0)
+  rdoc (~> 5.1, >= 5.1.0)
+  rspec (~> 3.5.0, >= 3.5.0)
+  simplecov (~> 0.13.0)
+  simplecov-html (~> 0.10.0)
+
+BUNDLED WITH
+   1.12.5

data/README.md

@@ -0,0 +1,24 @@
+# Ruby Brewer
+### A Ruby API for adaptiman/adaptibrew
+
+# Disclaimer
+This is just an API to make adaptibrew more user friendly. It will provide a clean shell and easy to understand methods for all the actions you need to control your brew rig. This will require an actual brew rig and all the equipment listed in [adaptiman/adaptibrew](https://github.com/adaptiman/adaptibrew). If you are looking to build an automated brew rig, **this is not the place to start**. Head over to [adaptiman/adaptibrew](https://github.com/adaptiman/adaptibrew), or hit up [adaptiman](https://github.com/adaptiman).
+
+# Installation
+This package is a weird half-breed Frankenstein's monster type of thing. You can install it as a gem with
+```shell
+gem install brewer
+```
+and `require 'brewer'` in your ruby code, or run
+```shell
+brewer
+```
+to open an interactive shell to control your brew rig in realtime. Fancy.
+
+# Documentation
+**Warning: RDoc may have a seizure when encountering Gemfiles, Rakefiles, etc. Basically files that don't end in `.rb` but have ruby syntax. Docs will be a bit weird on those files. I suggest just reading the comments in source.**
+Documentation is in `doc/` or on rubygems.org
+
+
+
+for build triggers, please ignore

data/Rakefile

@@ -0,0 +1,52 @@
+require 'git'
+require 'launchy'
+require 'rdoc/task'
+require 'rspec/core/rake_task'
+
+task default: %w[spec]
+
+# Unit testing
+# You can specify a specific test case to use
+# Ex: rake test['brewer']
+task :spec, [:tc] do |t, tc|
+  RSpec::Core::RakeTask.new(:spec)
+end
+
+# Opens code coverage in your browser
+# This may be a bit shaky. Only tested on Mac.
+# TODO: test on windows
+# You can just open 'coverage/index.html' in your browser.
+task :coverage do
+  Launchy.open(Dir.pwd + '/coverage/index.html')
+end
+
+# Generate or update documentation
+# Generates in `doc/`
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'doc/'
+  rdoc.rdoc_files.include("**/*.rb")
+end
+
+# Opens documentation.
+task :docs do
+  Launchy.open(Dir.pwd + '/doc/index.html')
+end
+
+# Clears coverage report
+task :clear_coverage do
+  rm_rf('coverage/')
+end
+
+# Adaptibrew tasks
+# Clear, Clone, and Refresh
+task :adaptibrew, [:method] do |t, method|
+  case method.to_a.first
+  when 'clear'
+    rm_rf 'adaptibrew/'
+  when 'clone'
+    Git.clone('https://github.com/adaptiman/adaptibrew.git', 'adaptibrew')
+  when 'refresh'
+    rm_rf 'adaptibrew/'
+    Git.clone('https://github.com/adaptiman/adaptibrew.git', 'adaptibrew')
+  end
+end

data/bin/brewer

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# 🍺🍺🍺
+# This executable will start a Ripl shell with a 'brewer' and 'adaptibrew' objects
+
+require 'ripl'
+
+require_relative "../lib/brewer"
+
+# Refresh to make sure we have the lastest version of adaptibrew
+adaptibrew = Adaptibrew.new.refresh
+
+brewer = Brewer.new
+
+puts "Warning: Adaptibrew has been cloned into the directory you executed 'brewer'"
+puts "You may wish to delete it when you are finished. Do that with `adaptibrew.clear`"
+puts "🍺  have fun 🍺"
+
+# 🍺🍺🍺
+Ripl.start :binding => binding
+# 🍺🍺🍺

data/brewer.gemspec

@@ -0,0 +1,33 @@
+require 'rake'
+
+Gem::Specification.new do |s|
+  s.name               = "brewer"
+  s.version            = "0.0.2"
+  s.default_executable = "brewer"
+
+  s.authors = ["Luke Sweeney"]
+  s.date = %q{2017-03-08}
+  s.description = %q{A Ruby API for adaptiman/adaptibrew}
+  s.email = %q{luke@thesweeneys.org}
+  s.files = FileList.new(['lib/*.rb', 'bin/*', '[A-Z]*', 'spec/*.rb']).to_a
+  s.executables = ['brewer']
+  s.bindir = 'bin'
+  s.test_files = FileList.new(["spec/*.rb"]).to_a
+  s.homepage = %q{http://github.com/llamicron/brewer}
+  s.require_paths = ["lib", "lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{A shell interface for adaptibrew}
+  s.license = 'MIT'
+
+  # Runtime dependencies
+  s.add_runtime_dependency 'git', '~> 1.3', '>= 1.3.0'
+  s.add_runtime_dependency 'ripl', '~> 0.7.0'
+
+  # Dev dependencies
+  s.add_development_dependency 'rake', '~> 12.0', '>= 12.0.0'
+  s.add_development_dependency 'rspec', '~> 3.5.0', '>= 3.5.0'
+  s.add_development_dependency 'launchy', '~> 2.4', '>= 2.4.0'
+  s.add_development_dependency 'simplecov', '~> 0.13.0'
+  s.add_development_dependency 'simplecov-html', '~> 0.10.0'
+  s.add_development_dependency 'rdoc', '~> 5.1', '>= 5.1.0'
+end

data/lib/adaptibrew.rb

@@ -0,0 +1,27 @@
+require 'git'
+require 'fileutils'
+
+# This is the 'manager' for the adaptibrew repo. It handles cloning and such.
+class Adaptibrew
+
+  # If used in IRB, Ripl, etc. it will clone into the directory IRB was started in
+  def clone(path=nil)
+    if !Dir.exists?('adaptibrew')
+      Git.clone('https://github.com/adaptiman/adaptibrew.git', 'adaptibrew', :path => path)
+    end
+    self
+  end
+
+  # Danger zone...
+  def clear()
+    FileUtils.rm_rf('adaptibrew')
+    self
+  end
+
+  def refresh
+    clear
+    clone
+    self
+  end
+
+end

data/lib/brewer.rb

@@ -0,0 +1,41 @@
+require_relative 'helpers'
+require_relative 'adaptibrew'
+
+include Helpers
+
+class Brewer
+
+  attr_reader :base_path
+  attr_accessor :out, :log
+
+  def initialize
+    @base_path = Dir.pwd
+    # Output of adaptibrew
+    @out = []
+    @log = @base_path + '/logs/output'
+  end
+
+  public
+
+  def wait(time=30)
+    sleep(time)
+    self
+  end
+
+  # Runs an adaptibrew script
+  # Output will be stored in @out
+  def script(script, params=nil)
+    @out.unshift(`python #{@base_path}/adaptibrew/#{script}.py #{params}`.chomp)
+    self
+  end
+
+  # Clears the @out array
+  # Writes current @out to log
+  # This is why the prod log is changed when tests are run
+  def clear
+    write_log(@log, @out)
+    @out = []
+    self
+  end
+
+end

data/lib/helpers.rb

@@ -0,0 +1,24 @@
+module Helpers
+
+  def log
+    Dir.pwd + '/logs/output'
+  end
+
+  # Formatted as: 03/07/2017 14:26
+  def time
+    Time.now.strftime("%m/%d/%Y %H:%M")
+  end
+
+  def clear_log(log)
+    File.truncate(log, 0)
+  end
+
+  def write_log(log, lines)
+    File.open(log, 'a') do |file|
+      lines.each do |line|
+        file.puts "[#{time}]: #{line}"
+      end
+    end
+  end
+
+end

data/spec/adaptibrew_spec.rb

@@ -0,0 +1,71 @@
+require_relative 'spec_helper'
+
+describe Adaptibrew do
+
+  before :each do
+    @adaptibrew = Adaptibrew.new.refresh
+  end
+
+  describe "#new" do
+    specify { expect(@adaptibrew).to be_an_instance_of Adaptibrew }
+  end
+
+  describe ".clear" do
+    context "when the repo already exists" do
+      specify { expect(Dir.exists?('adaptibrew')).to be true }
+
+      it "deletes the repo" do
+        @adaptibrew.clear
+        expect(Dir.exists?('adaptibrew')).to be false
+      end
+    end
+
+    context "when the repo does not exist" do
+      let(:adaptibrew) { Adaptibrew.new }
+      before { adaptibrew.clear }
+      specify { expect(Dir.exists?('adaptibrew')).to be false }
+
+      it "does nothing" do
+        @adaptibrew.clear
+        expect(Dir.exists?('adaptibrew')).to be false
+      end
+    end
+
+  end
+
+  describe ".clone" do
+    context "when the repo does not exist" do
+      let(:adaptibrew) { Adaptibrew.new }
+      before { adaptibrew.clear }
+      specify { expect(Dir.exists?('adaptibrew')).to be false }
+
+      it "clones the repo" do
+        @adaptibrew.clone
+        expect(Dir.exists?('adaptibrew')).to be true
+      end
+    end
+
+    context "when the repo exists" do
+      let(:adaptibrew) { Adaptibrew.new }
+      before { adaptibrew.clone }
+      specify { expect(Dir.exists?('adaptibrew')).to be true }
+
+      it "does nothing" do
+        @adaptibrew.clone
+        expect(Dir.exists?('adaptibrew')).to be true
+      end
+    end
+
+  end
+
+  describe ".refresh" do
+    let(:adaptibrew) { Adaptibrew.new }
+    before { adaptibrew.refresh }
+    it "clears and clones the repo" do # regardless of wether or not it's there
+      expect(Dir.exists?('adaptibrew')).to be true
+      @adaptibrew.refresh
+      expect(Dir.exists?('adaptibrew')).to be true
+    end
+  end
+
+end

data/spec/brewer_spec.rb

@@ -0,0 +1,46 @@
+require_relative 'spec_helper'
+
+describe Brewer do
+
+  before :each do
+    @brewer = Brewer.new
+  end
+
+  describe "#new" do
+    it "returns a brewer object" do
+      expect(@brewer).to be_an_instance_of Brewer
+    end
+  end
+
+  describe ".wait" do
+    # This is kind of iffy like the Helpers#time test
+    it "can wait for a number of seconds" do
+      #  not using let(:current_time) etc. because
+      # the var is created upon the first calling, which is in the expect()
+      current_time = Time.now.to_i
+      @brewer.wait(1)
+      expect(current_time + 1).to eq(Time.now.to_i)
+    end
+  end
+
+  describe ".script" do
+    it "can run a python script and get output" do
+      @brewer.script('python_tester')
+      expect(@brewer.out.first).to eq("it worked")
+    end
+  end
+
+  describe ".clear" do
+    context "when there is output" do
+      let(:brewer) { Brewer.new }
+      before { brewer.script('python_tester') }
+      specify { expect(brewer.out.first).to eq("it worked") }
+
+      it "can clear the output" do
+        @brewer.clear
+        expect(@brewer.out).to be_empty
+      end
+    end
+  end
+
+end

data/spec/helpers_spec.rb

@@ -0,0 +1,36 @@
+require_relative 'spec_helper'
+
+include Helpers
+
+describe "Helpers" do
+
+  it "returns the log file path" do
+    expect(log).to eq(Dir.pwd + '/logs/output')
+  end
+
+  it "can return the date/time" do
+    # This might not be consistent???
+    # What if the minute changes during tests?
+    # dunno lol
+    expect(time).to eq(Time.now.strftime("%m/%d/%Y %H:%M"))
+  end
+
+  context "when the log is empty" do
+    before { clear_log(log) }
+    specify { expect(File.zero?(log)).to be true }
+    it "can write to the log" do
+      write_log(log, ['log entry'])
+      expect(File.zero?(log)).to be false
+    end
+  end
+
+  context "when the log is not empty" do
+    write_log(log, ['log entry'])
+    specify { expect(File.zero?(log)).to be false }
+    it "can clear the log" do
+      clear_log(log)
+      expect(File.zero?(log)).to be true
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+# This is the helper file for rspec
+# For the spec of helpers.rb, see helper_spec.b
+# Code Coverage
+require 'simplecov'
+SimpleCov.command_name 'RSpec'
+SimpleCov.start
+
+require_relative '../lib/adaptibrew.rb'
+require_relative '../lib/brewer.rb'
+require_relative '../lib/helpers.rb'

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: brewer
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Luke Sweeney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: ripl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: simplecov-html
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+description: A Ruby API for adaptiman/adaptibrew
+email: luke@thesweeneys.org
+executables:
+- brewer
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/brewer
+- brewer.gemspec
+- lib/adaptibrew.rb
+- lib/brewer.rb
+- lib/helpers.rb
+- spec/adaptibrew_spec.rb
+- spec/brewer_spec.rb
+- spec/helpers_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/llamicron/brewer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- 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.4.8
+signing_key: 
+specification_version: 4
+summary: A shell interface for adaptibrew
+test_files:
+- spec/adaptibrew_spec.rb
+- spec/brewer_spec.rb
+- spec/helpers_spec.rb
+- spec/spec_helper.rb