fudge 0.4.1 → 0.5.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YjM3NjNkZTE2YjE3ZjcxZjg0OTFlZTNiMzg4NTA1MTI4MjJjMTYyZg==
-  data.tar.gz: !binary |-
-    MDBkMDczNmI3ZGFhZGM1YjM4YTM0ZjNhNTViNTFlYzE1YWY5MTE3Mg==
+SHA1:
+  metadata.gz: 71397d8944c4873910bdeaf7a2bde5306c83c48a
+  data.tar.gz: da1fbf7b677ee5674eaea1d7fee50a200dc5ba58
 SHA512:
-  metadata.gz: !binary |-
-    MjNjMWZlNGRmMjgwMGNhNGRiMDYyMDc5NzIyZTYwYzZkMTAxNzc3Njk2MjZj
-    MmQ1YmYyNzc3NTJhNzRhYjkwZmQ0OWJmY2QwNzUwMDIyM2EyYmI3NTA3ZTYx
-    MGIwZTQ3MDEwM2ZhYmZlYTZkNGNiZTIwMTE0ZmZkYjViMWNhMTM=
-  data.tar.gz: !binary |-
-    ZWEwZGUxN2YxMDhkMzNkM2VkNjYzY2FjNDIwOWM4OTlmY2Y5NTBmN2U0MjFh
-    MmVkMjA3OWQ4Nzk1ZjJlNWZhNDk0OGExOTg5ZDVkNjk3NGZlYTVlZDdmMmMz
-    NTc4OWQ2MDgxYjgwNzAzNDcwY2FiMjUzZDJjNmQxNWNkMmJhOTc=
+  metadata.gz: 39bfead33b001ff814a94b78c4a9a67fdbbc37dd16fe1e84edcd620869bfaf982baf7117812b1d03a5d0eeece96dbb58bfae0fe6eb8979101e4d4b95db8cfb79
+  data.tar.gz: e971f34d8b60543e9c6e30bb765991ade37368378f7f56e9c2a7b5be6db7fbf5f16aca469b0fb87c6630243bf45d6699fe5ceb3be2910d68ecff5427f7986e9e

data/lib/fudge/build.rb

@@ -2,8 +2,13 @@ module Fudge
   # Represents a build defined in the FudgeFile
   #
   class Build < Tasks::CompositeTask
+    # @!attribute about
+    #   @return [String] a brief description of the build; this is
+    #                    output by the 'list' command
+    attr_accessor :about
     attr_accessor :callbacks
     attr_reader :success_hooks, :failure_hooks
+    attr_reader :description
 
     def initialize(*args)
       @success_hooks = []

data/lib/fudge/cli.rb

@@ -7,7 +7,8 @@ module Fudge
     # Initalizes the blank Fudgefile
     def init
       generator = Fudge::Generator.new(Dir.pwd)
-      generator.write_fudgefile
+      msg = generator.write_fudgefile
+      shell.say msg
     end
 
     desc "build [BUILD_NAME]",
@@ -19,5 +20,24 @@ module Fudge
       description = Fudge::Parser.new.parse('Fudgefile')
       Fudge::Runner.new(description).run_build(build_name, options)
     end
+
+    desc "list [FILTER]",
+      "List all builds defined in the Fudgefile that match FILTER (default: list all)"
+    # Lists builds defined in Fudgefile, with optional filtering.
+    #
+    # If given no filter, all builds are listed.  If given a filter,
+    # lists builds whose names match the filter.  Matching is based on
+    # sub-string matching and is case insensitive.
+    #
+    # The listing includes the build name, followed by the about
+    # string if one was specified in the Fudgefile.
+    #
+    # @param [String] filter  a string by which to filter the builds listed
+    def list(filter="")
+      description = Fudge::Parser.new.parse('Fudgefile')
+      builds = description.builds.map { |name, build| ["#{name}", build.about] }
+      matches = builds.select { |name, _| name =~ /#{filter}/i }
+      shell.print_table(matches, :indent => 2, :truncate => true)
+    end
   end
 end

data/lib/fudge/description.rb

@@ -15,8 +15,8 @@ module Fudge
     end
 
     # Adds a build to the current description
-    def build(name)
-      @builds[name] = build = Build.new
+    def build(name, options={})
+      @builds[name] = build = Build.new(options)
       with_scope(build) { yield }
     end
 

data/lib/fudge/generator.rb

@@ -10,10 +10,10 @@ module Fudge
     #Writes the fudgefile to initialized directory unless on present
     def write_fudgefile
       if exists?
-        puts "Fudgefile already exists."
+        "Fudgefile already exists."
       else
         writer { |file| file << build_templated }
-        puts "Fudgefile created."
+        "Fudgefile created."
       end
     end
 

data/lib/fudge/version.rb

@@ -1,4 +1,4 @@
 module Fudge
   # Define gem version
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

data/spec/lib/fudge/cli_spec.rb

@@ -20,8 +20,7 @@ describe Fudge::Cli do
 
   describe :build do
     before :each do
-      File.open('Fudgefile', 'w') do |f|
-        contents = <<-RUBY
+      contents = <<-RUBY
           build :default do
             dummy
           end
@@ -30,47 +29,140 @@ describe Fudge::Cli do
             another_dummy
           end
         RUBY
-        f.write(contents)
-      end
+      file = double(File, read: contents, path: 'here')
+      File.stub(:open) { |&block| block.yield file }
     end
 
-    it "should run the default build" do
-      subject.build 'default'
-      DummyTask.ran.should be_true
+    context "when not given a build name" do
+      it "runs the default build" do
+        subject.build 'default'
+        expect(DummyTask.ran).to be_true
+      end
     end
 
-    it "should accept a build name to run" do
-      subject.build 'other'
-      DummyTask.ran.should be_false
-      AnotherDummyTask.ran.should be_true
+    context "when given a build name" do
+      it "runs the only the named build" do
+        subject.build 'other'
+        expect(DummyTask.ran).to be_false
+        expect(AnotherDummyTask.ran).to be_true
+      end
     end
   end
 
   describe :init do
-    it "should create a new FudgeFile in the current directory" do
-      File.should_not be_exists('Fudgefile')
+    let (:file_state) { { exists: false, content: '' } }
+    let (:override_file_state) do
+      ->(exists, content) {
+        file_state[:exists] = exists
+        file_state[:content] = content
+      }
+    end
 
-      subject.init
+    before :each do
+      file = double(File)
+      file.stub(:<<) { |str| file_state[:content] = str }
+      file.stub(:read) { file_state[:content] }
+      File.stub(:open) do |&block|
+        file_state[:exists] = true
+        block.yield file
+      end
+      File.stub(:exists?) { |_| file_state[:exists] }
 
-      File.should be_exists('Fudgefile')
+      @output = ''
+      shell = double('Thor::Shell')
+      shell.stub(:say) { |what| @output = what }
+      subject.stub(:shell).and_return(shell)
     end
 
-    it "should contain a default build" do
-      subject.init
+    context "when a Fudgefile does not exist in the current directory" do
+      it "creates a new FudgeFile" do
+        expect(File).not_to be_exists('Fudgefile')
+
+        subject.init
+
+        expect(File).to be_exists('Fudgefile')
+      end
+
+      it "writes a default build into the new Fudgefile" do
+        subject.init
 
-      File.open('Fudgefile', 'r') do |f|
-        f.read.should eql "build :default do\n  task :rspec\nend"
+        File.open('Fudgefile', 'r') do |f|
+          expect(f.read).to eql "build :default do\n  task :rspec\nend"
+        end
+      end
+
+      it "outputs a success message" do
+        subject.init
+        expect(@output).to eq 'Fudgefile created.'
       end
     end
 
-    it "should not modify the Fudgefile if one exists" do
-      File.open('Fudgefile', 'w') do |f|
-        f.write('foo')
+    context "when a Fudgefile already exists in the current directory" do
+      before :each do
+        override_file_state.(true, 'foo')
       end
 
-      subject.init
+      it "does not modify the existing Fudgefile" do
+        expect(File).to be_exists('Fudgefile')
+
+        subject.init
+
+        expect(File.open('Fudgefile') { |f| f.read }).to eql 'foo'
+      end
 
-      File.open('Fudgefile') { |f| f.read }.should == 'foo'
+      it "outputs a failure message" do
+        subject.init
+        expect(@output).to eq 'Fudgefile already exists.'
+      end
     end
   end
+
+  describe :list do
+    before :each do
+      contents = <<-RUBY
+          build :default do
+            dummy
+          end
+
+          build :other, :about => 'not the default' do
+            another_dummy
+          end
+        RUBY
+      file = double(File, read: contents, path: 'here')
+      File.stub(:open) { |&block| block.yield file }
+
+      @output = ''
+      shell = double('Thor::Shell')
+      shell.stub(:print_table) { |tab| @output = tab.map { |build, desc| "#{build}\t#{desc}" }.join("\n") }
+      subject.stub(:shell).and_return(shell)
+    end
+
+    context "when not given a filter string" do
+      it "lists all the defined builds" do
+        subject.list
+        expect(@output).to eql "default\t\nother\tnot the default"
+      end
+    end
+
+    context "when given a filter string" do
+      context "that matches one or builds" do
+        it "lists only the builds that match the filter" do
+          subject.list 'oth'
+          expect(@output).to eql "other\tnot the default"
+        end
+
+        it "ignores the case of the filter" do
+          subject.list 'OTH'
+          expect(@output).to eql "other\tnot the default"
+        end
+      end
+
+      context "that matches no builds" do
+        it "outputs nothing" do
+          expect(@output).to eql ''
+        end
+      end
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fudge
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Sage One team
@@ -14,252 +14,252 @@ dependencies:
   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: activesupport
   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: json
   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: redcarpet
   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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.8.0
 - !ruby/object:Gem::Dependency
   name: guard-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: rb-fsevent
   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: yard
   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: cane
   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: flog
   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: flay
   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: ruby2ruby
   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: RedCloth
   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: simplecov
   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: rb-inotify
   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: libnotify
   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: rake
   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'
 description: Fudge Continuous Integration Server
@@ -341,12 +341,12 @@ 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: []