brewer 0.0.10 → 0.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05f55e89e2c9ad592085d64754888f105044b351
-  data.tar.gz: 50a46c28e5de6f966fc1172279bd37eb57477f73
+  metadata.gz: 6fd3151ef2ca1e31779cd287565ec95a6bef5726
+  data.tar.gz: b6d6689d3681a42b5293ea784399ea9072f34494
 SHA512:
-  metadata.gz: 907d730e9896a91cd3829e71bc721aab7040c202f5c7763e345b06bbb297e5fee779ca0132942f428f33e7fc741b5ae27ef4c28e24330771774ffde8f40985c1
-  data.tar.gz: bd2af95aca5b6ad34ba05537b3e6a2f8bad7bf7d3c351e3294a7062cbb186fb691fc5e754d2c536f45c11c406d696fbc0744491ad6eb726e55e601cf6ecf904b
+  metadata.gz: b63a554cc5966155fa62a37f91ee7625efc38d5997a8fde3009e670a544e9f83ecbdb93a934c28f55feb024582e4bfe58f34c197a062b0bd1fcb4d28a74fda78
+  data.tar.gz: fda7bd47781e154b96fe918fb5e44192f964000a64d6b11967a6a17d87228fb17d2237f9baa84306d5867b2d3a4094a8044b3ff730e9a389a97b983a72417e7a

data/Gemfile

@@ -1,18 +1,3 @@
 source "https://rubygems.org"
 
-# Yes, I use a Gemfile and .gemspec. Get over it. This is largely a personal project,
-# but i would like some of the things gems provide.
-
 gemspec
-
-gem 'ripl'
-gem 'git'
-
-group :test do
-  gem 'rake'
-  gem 'test-unit'
-  gem 'launchy'
-  gem 'simplecov'
-  gem 'simplecov-html'
-  gem 'rdoc'
-end

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    brewer (0.0.9)
-      git (>= 0.0.0)
-      ripl (>= 0.0.0)
+    brewer (0.0.10)
+      git (~> 1.3, >= 1.3.0)
+      ripl (~> 0.7.0)
 
 GEM
   remote: https://rubygems.org/
@@ -11,38 +11,47 @@ GEM
     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)
-    power_assert (0.2.2)
     public_suffix (2.0.4)
     rake (12.0.0)
-    rdoc (4.2.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)
-    test-unit (3.0.8)
-      power_assert
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   brewer!
-  git
-  launchy
-  rake
-  rdoc
-  ripl
-  simplecov
-  simplecov-html
-  test-unit
+  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

@@ -18,3 +18,7 @@ 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

@@ -1,18 +1,15 @@
 require 'git'
 require 'launchy'
 require 'rdoc/task'
+require 'rspec/core/rake_task'
 
-task default: %w[test]
+task default: %w[spec]
 
 # Unit testing
 # You can specify a specific test case to use
 # Ex: rake test['brewer']
-task :test, [:tc] do |t, tc|
-  if tc.to_a.any?
-    ruby "tests/tc_#{tc.to_a[0]}.rb"
-  else
-    ruby "tests/ts_all.rb"
-  end
+task :spec, [:tc] do |t, tc|
+  RSpec::Core::RakeTask.new(:spec)
 end
 
 # Opens code coverage in your browser

data/bin/brewer

@@ -1,20 +1,20 @@
 #!/usr/bin/env ruby
-# This script will initialize a Ripl shell with a brewer instantiated
+# 🍺🍺🍺
+# This executable will start a Ripl shell with a 'brewer' and 'adaptibrew' objects
+
 require 'ripl'
 
-# pull in our source
 require_relative "../lib/brewer"
 
-# Get an adaptibrew instance and refresh the repo
+# Refresh to make sure we have the lastest version of adaptibrew
 adaptibrew = Adaptibrew.new.refresh
 
-# Start up a brewer
 brewer = Brewer.new
 
-# Warning
 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 🍺"
 
-# Start the ripl shell
+# 🍺🍺🍺
 Ripl.start :binding => binding
-# Start brewing
+# 🍺🍺🍺

data/brewer.gemspec

@@ -2,31 +2,30 @@ require 'rake'
 
 Gem::Specification.new do |s|
   s.name               = "brewer"
-  s.version            = "0.0.10"
+  s.version            = "0.0.21"
   s.default_executable = "brewer"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   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]*', 'tests/*.rb']).to_a
+  s.files = FileList.new(['lib/*.rb', 'bin/*', '[A-Z]*', 'spec/*.rb']).to_a
   s.executables = ['brewer']
   s.bindir = 'bin'
-  s.test_files = FileList.new(["tests/*.rb"]).to_a
+  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'
 
-  # TODO: update these versions
-
+  # 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 'test-unit', '~> 3.2', '>= 3.2.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'

data/lib/adaptibrew.rb

@@ -4,10 +4,8 @@ require 'fileutils'
 # This is the 'manager' for the adaptibrew repo. It handles cloning and such.
 class Adaptibrew
 
-  # Clone the repo into the current directory, unless a path is provided
   # If used in IRB, Ripl, etc. it will clone into the directory IRB was started in
   def clone(path=nil)
-    # Don't clone if it's already there.
     if !Dir.exists?('adaptibrew')
       Git.clone('https://github.com/adaptiman/adaptibrew.git', 'adaptibrew', :path => path)
     end
@@ -15,14 +13,11 @@ class Adaptibrew
   end
 
   # Danger zone...
-  # Clears the adaptibrew repo
   def clear()
     FileUtils.rm_rf('adaptibrew')
     self
   end
 
-  # Clear and re-clone the adaptibrew repo
-  # This can also serve as an update method
   def refresh
     clear
     clone

data/lib/brewer.rb

@@ -3,44 +3,34 @@ require_relative 'adaptibrew'
 
 include Helpers
 
-# This is the main brewer class.
-# This contains all the methods needed to control a brew rig
-# setup with adaptiman/adaptibrew.
 class Brewer
 
-  # Path to the gem root
   attr_reader :base_path
-
-  # Output of adaptibrew
-  attr_accessor :out
+  attr_accessor :out, :log
 
   def initialize
-    # Path of the package
     @base_path = Dir.pwd
-    # Output from adaptibrew
+    # Output of adaptibrew
     @out = []
-    # Log file for @out. Everything in the log file will be from @out.
     @log = @base_path + '/logs/output'
   end
 
   public
 
-  # Waits for `time` seconds. Pretty simple stuff.
   def wait(time=30)
-    puts "Waiting for #{time} seconds"
     sleep(time)
     self
   end
 
   # Runs an adaptibrew script
-  # Output will be stored in `@out'
+  # 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
+  # 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)

data/lib/helpers.rb

@@ -1,27 +1,18 @@
-# Helpers Module.
-# For methods that don't quite fit anywhere else,
-# or that I need globally
 module Helpers
 
-  # Returns the default location for the log file.
-  # A different log file is used for testing
   def log
     Dir.pwd + '/logs/output'
   end
 
-  # Gets the current date and time
   # Formatted as: 03/07/2017 14:26
   def time
     Time.now.strftime("%m/%d/%Y %H:%M")
   end
 
-  # Truncates (deletes) the entire log
   def clear_log(log)
     File.truncate(log, 0)
   end
 
-  # Writes each `line` element to `logs/output` with a timestamp. Example:
-  # [03/07/2017 14:27]: it worked
   def write_log(log, lines)
     File.open(log, 'a') do |file|
       lines.each do |line|

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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brewer
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.21
 platform: ruby
 authors:
 - Luke Sweeney
@@ -65,25 +65,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 12.0.0
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 3.5.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 3.5.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: launchy
   requirement: !ruby/object:Gem::Requirement
@@ -168,10 +168,10 @@ files:
 - lib/adaptibrew.rb
 - lib/brewer.rb
 - lib/helpers.rb
-- tests/tc_adaptibrew.rb
-- tests/tc_brewer.rb
-- tests/tc_helpers.rb
-- tests/ts_all.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
@@ -198,7 +198,7 @@ signing_key:
 specification_version: 4
 summary: A shell interface for adaptibrew
 test_files:
-- tests/tc_adaptibrew.rb
-- tests/tc_brewer.rb
-- tests/tc_helpers.rb
-- tests/ts_all.rb
+- spec/adaptibrew_spec.rb
+- spec/brewer_spec.rb
+- spec/helpers_spec.rb
+- spec/spec_helper.rb

data/tests/tc_adaptibrew.rb

@@ -1,26 +0,0 @@
-require 'test/unit'
-require_relative '../lib/adaptibrew'
-
-class TestGit < Test::Unit::TestCase
-
-  def setup
-    @adaptibrew = Adaptibrew.new
-  end
-
-  # `refresh` calls both `clone` and `clear`. oh that sweet, sweet code coverage
-  def test_refresh
-    @adaptibrew.refresh
-    assert_true(Dir.exists?('adaptibrew'))
-  end
-
-  # Testing a not-so-failed case of cloning
-  def test_clone_will_skip_if_repo_present
-    @adaptibrew.refresh
-    assert_equal(@adaptibrew, @adaptibrew.clone)
-  end
-
-  def teardown
-    @adaptibrew.refresh
-  end
-
-end

data/tests/tc_brewer.rb

@@ -1,45 +0,0 @@
-require 'test/unit'
-
-require_relative '../lib/brewer'
-require_relative '../lib/adaptibrew'
-
-# Test the brewer class
-class TestBrewer < Test::Unit::TestCase
-
-  def setup
-    @brewer = Brewer.new
-    Adaptibrew.new.refresh
-    # This is used for log testing, not logging tests. see `test_log_methods`
-    @log = @brewer.base_path + '/logs/test_output'
-  end
-
-  # Make sure that the path is correct. I hate working with paths.
-  # TODO: Test this on windows
-  def test_base_path
-    assert_equal(Dir.pwd, @brewer.base_path)
-  end
-
-  # Don't really know how to test this one...
-  # Just running the code for coverage and to pick up any stray errors
-  def test_wait
-    @brewer.wait(0.1)
-    assert_true(true)
-  end
-
-  # Runs the 'python_tester.py' which print "it worked".
-  # Ensures that ruby can run python without errors.
-  def test_script_and_output
-    @brewer.script('python_tester')
-    assert_equal("it worked", @brewer.out.first)
-  end
-
-  # Tests if the adaptibrew output (@brewer.out) can be cleared.
-  # This invloves writing to the log file
-  def test_clear_output
-    @brewer.script('python_tester')
-    assert_equal("it worked", @brewer.out.first)
-    @brewer.clear
-    assert_equal(nil, @brewer.out.first)
-  end
-
-end

data/tests/tc_helpers.rb

@@ -1,42 +0,0 @@
-require 'test/unit'
-
-require_relative '../lib/helpers'
-
-class TestHelpers < Test::Unit::TestCase
-
-  def setup
-    @brewer = Brewer.new
-    # See comment on `test_log`
-    @log = @brewer.base_path + '/logs/test_output'
-    clear_log(@log)
-  end
-
-  # Test that Helpers#time will rturn a string
-  # Not sure how to test the format, since that would require knowing the actual
-  # time. Might get messy.
-  def test_time
-    assert_equal(String, time.class)
-  end
-
-  def test_log
-    # This will give us the actual log i.e. '/logs/output', not the test log
-    assert_equal(Dir.pwd + "/logs/output", log)
-  end
-
-  def test_log_methods
-    # Clear adaptibrew ouput from brewer
-    @brewer.clear
-
-    clear_log(@log)
-    assert_true(File.zero?(@log))
-
-    # Get some output
-    @brewer.script('python_tester')
-    assert_true(@brewer.out.any?)
-
-    # Write output
-    write_log(@log, @brewer.out)
-    assert_true(!File.zero?(@log))
-  end
-
-end

data/tests/ts_all.rb

@@ -1,16 +0,0 @@
-# Code Coverage
-require 'simplecov'
-SimpleCov.command_name 'Unit Tests'
-SimpleCov.start
-
-# Require helper methods
-require_relative '../lib/helpers'
-include Helpers
-
-# Test Framework
-require 'test/unit'
-
-# Test Cases
-require_relative 'tc_adaptibrew'
-require_relative 'tc_brewer'
-require_relative 'tc_helpers'