rulebow 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: efb2f96a12212f411d2f026740cdbc3b1134b7f6
+  data.tar.gz: e6c235f0892da2fad2bd5b630a9ef32bc0815936
+SHA512:
+  metadata.gz: fa905ec3302359749739885dcf93ebd069eb20aa20f91ce6116ebe463aa6caa6899e981fc9202fc7b9b2fe17635f7a6733f994eb388650046c8518536df4e2ec
+  data.tar.gz: e3f6ed30330abbc90a777b77ca1e3e33225d861f83988622dd6341c9a1fdea99423d6787458202ae8bf7604b28a8d3ce93ff8a425bbfbda10be626a596297d59

data/.index

@@ -0,0 +1,61 @@
+---
+revision: 2013
+type: ruby
+sources:
+- INDEX.yml
+authors:
+- name: trans
+  email: transfire@gmail.com
+organizations:
+- name: Rubyworks
+requirements:
+- name: notify
+- groups:
+  - build
+  development: true
+  name: detroit
+- groups:
+  - build
+  development: true
+  name: mast
+- groups:
+  - test
+  development: true
+  name: qed
+- groups:
+  - test
+  development: true
+  name: ae
+conflicts: []
+alternatives: []
+resources:
+- type: home
+  uri: http://rubyworks.github.com/rulebow
+  label: Homepage
+- type: code
+  uri: http://github.com/rubyworks/rulebow
+  label: Source Code
+- type: bugs
+  uri: http://github.com/rubyworks/rulebow/issues
+  label: Issue Tracker
+repositories:
+- name: upstream
+  scm: git
+  uri: git://github.com/rubyworks/rulebow.git
+categories: []
+copyrights:
+- holder: Rubyworks
+  year: '2010'
+  license: BSD-2-Clause
+customs: []
+paths:
+  lib:
+  - lib
+name: rulebow
+title: RULEBOW
+version: 0.4.0
+summary: An autological build tool.
+description: Rulebow is an automated build tool with a set-logic based rule system.
+  Rulebow is the perfect tool for performing continuous integration during development.
+created: '2010-07-05'
+date: '2015-02-28'

data/.yardopts

@@ -0,0 +1,10 @@
+--title Ergo
+--readme README.md
+--plugin tomdoc
+--private
+--protected
+lib
+-
+*.md
+*.txt
+

data/HISTORY.md

@@ -0,0 +1,62 @@
+# RELEASE HISTORY
+
+## 0.4.0 / 2014-02-29
+
+This major release renames the project from **Ergo** to **Rulebow**.
+This will be the last name change. Promise. In addition a number of
+other adjustments and code improvements have been made. This may be
+the first release that's actually usable in production.
+
+Changes:
+ 
+* Rename project to Rulebow.
+* Rename `book` method to `ruleset`.
+* Rename `state` method to `fact`.
+* Use single `Rulebook` file.
+
+
+## 0.3.0 / 2013-02-13
+
+Major release removes tasks. There are only rules now! In
+addition *books* have been added which allow rules to be
+grouped together. Oh! And you might have noticed the name
+of the project has changed from *Fire* to *Ergo*.
+
+Changes:
+
+* Deprecate tasks.
+* Add rule books.
+* Rename project to Ergo.
+
+
+## 0.2.0 / 2013-02-12
+
+This is the last version with tasks. Tasks are being deprecated
+for two reasons: a) they add a great deal of complexity to the
+syntax and the implementation via their need for dependencies;
+and b) tasks have proven to be an excuse for poorly designed 
+rules, which, if properly written, would do the job just as well
+if not better than any task. So it was decided that if tasks are
+needed, then they should be provided via dedicated task system,
+not via the rules system.
+
+Changes:
+
+* Default rule file is now `.fire/rules.rb` or `rules.rb`.
+* Rules can depend on tasks using same hash notation as tasks.
+* Modified the `#rule` method to define file rules given a string.
+* Deprecated the `file` method for defining file rules.
+
+
+## 0.1.0 / 2012-04-10
+
+This is the initial release of Fire. Fire is state and rules-based
+continuous integration and build tool.
+
+Special thanks to Ari Brown for letting us take over the fire gem
+for this project.
+
+Changes:
+
+* Happy first release day!
+

data/LICENSE.txt

@@ -0,0 +1,25 @@
+(BSD-2-Clause License)
+
+Redistribution and use in source and binary forms,
+with or without modification, are permitted provided that the following
+conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR  SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+

data/README.md

@@ -0,0 +1,168 @@
+# RULEBOW
+
+[Homepage](http://rubyworks.github.com/rulebow) -
+[Report Issue](http://github.com/rubyworks/rulebow/issues) -
+[Source Code](http://github.com/rubyworks/rulebow) -
+[IRC Channel](http://chat.us.freenode.net/rubyworks)
+
+***"Hey, you got logic in my build tool!"***
+
+Rulebow is a build tool that promotes continuous integration via logic
+programming. With Rulebow, the Ruby developer defines *rules* and state
+conditions called *facts*. The rules are applied when their conditions
+are met. Through repetitive application, this allows a project to all
+but manage itself.
+
+Rulebow is not complicated. It does not require a bazillion plug-ins.
+Although some external tools can be helpful and used with it, and
+it makes some procedures more convenient. For example, it makes
+FileUtils methods directly available in the build script context.
+Mostly it just trusts the developer to know how to write the build
+scripts they need.
+
+Below you will find a brief "Hot Minute" guide for getting up and
+running with Rulebow quickly. It's just enough to give you familiarity
+the basic ideas of Rulebow and how to start putting it to good use.
+For more detailed instruction, explanation of terms and how the
+dickens does it work under-the-hood, please consider any of the
+following resources.
+
+* [Overview of Rulebow](https://github.com/rubyworks/rulebow/wiki/Overview)
+* [Helpful FAQs](https://github.com/rubyworks/rulebow/wiki/FAQ)
+* [Rulebow Recepies](https://github.com/rubyworks/rulebow/wiki/Recipes)
+* [API Documentation](http://rubydoc.info/gems/rulebow/frames)
+
+
+## Rulebow in a Hot Minute
+
+To install, either use RubyGems directly:
+
+```
+  $ gem install rulebow
+```
+
+Or add `gem "rulebow"` to your Gemfile and run:
+
+```
+  $ bundle
+```
+
+Creat a `Rulebook` file in your project.
+
+```
+  $ vi Rulebook
+```
+
+And add the following example script to the file.
+
+```ruby
+ruleset :default => [:manifest, :test]
+
+ruleset :manifest do
+  desc "update manifest"
+
+  globs = %w[bin/**/* lib/**/* *.md]
+
+  fact :need_manifest? do
+    if File.exist?('MANIFEST')
+      files = globs.map{ |d| Dir[d] }.flatten
+      saved = File.readlines('MANIFEST').map{ |f| f.strip }
+      files != saved
+    else
+      true
+    end
+  end
+
+  rule :need_manifest? do
+    files = globs.map{ |d| Dir[d] }.flatten
+    File.open('MANIFEST', 'w'){ |f| f << files.join("\n") }
+  end
+end
+
+ruleset :test do
+  desc "run my minitests"
+
+  rule 'lib/**/*.rb' do |libs|
+    $: << 'lib'
+    files = Dir.glob('test/**/*_test.rb') 
+    files.each{|file| require "./" + file}
+  end
+```
+
+Now run it with:
+
+    $ bow
+
+And there you go. Rulebow, in a hot minute!
+
+
+## A Few More Minutes
+
+As the capable Ruby programmer, it probable doesn't require much explanation
+to understand the above code and what happened when you ran it. Just the
+same, it can help to go over it with the proper terminology. Of course,
+the rules in our example are simplistic and they make some basic
+assumptions about a project, so you will want to modify these to suite your
+needs (or dispose of them and write fresh). Nonetheless, this example
+provides some clear examples of the basics of writing Rulebow scripts.
+
+The first line in the script defines the defauly ruleset. This is the
+ruleset the is executes when no specific ruleset is designated on
+the command line. In this case we see that it simply depends on two
+other rulesets, `test` and `manifest`.
+
+Nex in the example we create the `manifest` ruleset. In it we first
+create a *state* called `update_manifest?`. It simply checks to see
+if the list of files in the project's MANIFEST file matches the project
+files expected to be there. Notice it returns a boolean value, true or
+false. Along with this state we create a *rule* that uses the state by
+calling the `update_manifest?` method. This method was created by the
+state definition above. The *rule procedure* updates the MANIFEST file
+whenever the state returns `true`, i.e. the manifest does not have the
+expected content.
+
+At the end of our example script we create an additional ruleset. This
+one does not reference a defined state. Instead it creates a *file state*
+implicitly by passing a string argument to `rule`. A file state has a
+very simple and very useful definition. It returns `true` whenever a
+matching file has changed from one execution of `rulebow` to the next.
+In other words, per this example, whenever a Ruby file in the `lib` 
+directory changes, Rulebow is going to run the units tests in the `test` 
+directory.
+
+Okay, so now we have an example rulebook and have a basic grasp of
+how it works. And we know we can run the rules simple by invoking the
+`rulebow` command on the command line. But if we want to have rulebow run
+automatically periodically, we can pass it the number of seconds to
+wait between runs via the `-a/--auto` option.
+
+    $ bow -a 180
+
+See it pays to read all the way to the end ;)
+
+
+## Contributing
+
+The Rulebow [repository](http://github.com/rubyworks/rulebow) is hosted on GitHub.
+If you would like to contribute to the project (and we would be over joyed
+if you did!) the rules of engagements are very simple.
+
+1. Fork the repo.
+2. Branch the repo.
+3. Code and test.
+4. Push the branch.
+4. Submit pull request.
+
+
+## Copyrights
+
+Rulebow is copyrighted open-source software.
+
+    Copyright (c) 2011 Rubyworks. All rights reserved.
+
+It is modifiable and redistributable under the terms of the
+[BSD-2-Clause](http::/spdx.org/licenses/BSD-2-Clause) license.
+
+See the enclosed LICENSE.txt file for details.
+
+(火 由)

data/bin/bow

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'rulebow'
+Rulebow::CLI.fire!
+

data/demo/03_runner/01_applying_rules.md

@@ -0,0 +1,51 @@
+## Applying Rules
+
+The `Runner` class handles running rules. It takes `System` as an argument and
+can run all applicable rules of a specific book.
+
+### True/False Rules
+
+The simplist rule state is `true`, which means it will always run, or
+`false` which means it will never run. These states are not very useful,
+but they should still work.
+
+Given a @system and a @ruleset defined with a simple always-true rule,
+and another always-false rule:
+
+    rule(true) do
+      assert true
+    end
+
+    rule(false) do
+      assert false
+    end
+
+Then the Runner should run the true rule and not the false rule when
+applying the system's rules.
+
+    runner = Rulebow::Runner.new(:system=>@system)
+
+    runner.run('example')
+
+### Simple State Rule
+
+Given a @system and a @ruleset defined with a simple state:
+
+    def simple
+      true
+    end
+
+    rule :simple do
+      assert true
+    end
+
+    rule false do
+      assert false
+    end
+
+Then the Runner should run the simple rule, but not the other.
+
+    runner = Rulebow::Runner.new(:system=>@system)
+
+    runner.run('example')
+

data/demo/applique/ae.rb

@@ -0,0 +1 @@
+require 'ae'

data/demo/applique/rulebow.rb

@@ -0,0 +1,11 @@
+require 'rulebow'
+
+When 'iven a @system and a @ruleset defined with' do |text|
+  @system = Rulebow::System.new(:root=>Dir.pwd, :statefile=>'example.state')
+  @ruleset = (
+    @system.ruleset(:example) do
+      module_eval(text)
+    end
+  )
+end
+

data/lib/rulebow.rb

@@ -0,0 +1,21 @@
+# ruby standard library
+require 'fileutils'
+require 'digest/sha1'
+require 'ostruct'
+
+# third party library
+require 'notify'
+
+# internal library
+require_relative 'rulebow/core_ext'
+require_relative 'rulebow/match'
+require_relative 'rulebow/shellutils'
+require_relative 'rulebow/fact'
+require_relative 'rulebow/rule'
+#require_relative 'rulebow/ignore'
+require_relative 'rulebow/watchlist'
+require_relative 'rulebow/digest'
+require_relative 'rulebow/ruleset'
+require_relative 'rulebow/system'
+require_relative 'rulebow/runner'
+require_relative 'rulebow/cli'

data/lib/rulebow.yml

@@ -0,0 +1,61 @@
+---
+revision: 2013
+type: ruby
+sources:
+- INDEX.yml
+authors:
+- name: trans
+  email: transfire@gmail.com
+organizations:
+- name: Rubyworks
+requirements:
+- name: notify
+- groups:
+  - build
+  development: true
+  name: detroit
+- groups:
+  - build
+  development: true
+  name: mast
+- groups:
+  - test
+  development: true
+  name: qed
+- groups:
+  - test
+  development: true
+  name: ae
+conflicts: []
+alternatives: []
+resources:
+- type: home
+  uri: http://rubyworks.github.com/rulebow
+  label: Homepage
+- type: code
+  uri: http://github.com/rubyworks/rulebow
+  label: Source Code
+- type: bugs
+  uri: http://github.com/rubyworks/rulebow/issues
+  label: Issue Tracker
+repositories:
+- name: upstream
+  scm: git
+  uri: git://github.com/rubyworks/rulebow.git
+categories: []
+copyrights:
+- holder: Rubyworks
+  year: '2010'
+  license: BSD-2-Clause
+customs: []
+paths:
+  lib:
+  - lib
+name: rulebow
+title: RULEBOW
+version: 0.4.0
+summary: An autological build tool.
+description: Rulebow is an automated build tool with a set-logic based rule system.
+  Rulebow is the perfect tool for performing continuous integration during development.
+created: '2010-07-05'
+date: '2015-02-28'