flow-lite 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4af502cc9764efd28671cbd3e4e498c0cc9dbd87
-  data.tar.gz: af96b08715862f411dfb3cdc7a2b87bc8ac4c8e6
+  metadata.gz: fd6dc6a4982583a8267aea617e5d7852321b7a00
+  data.tar.gz: 5e050df47d5f1d52881c2666f1bb732f39cb4981
 SHA512:
-  metadata.gz: c2edc964d13234f76c67c52989e4ff9e664164a61ba185f472d6f24a6300d1ee87cdc8ec30eb40a88258fd9beb63e133f95e852249b7f0d5b624e17430a86b31
-  data.tar.gz: 90a4af15059474729db047b8ad658c36cfacbcdfd0db1802ec29423d22893806eea0a9beeb371364a05f848ffbf8b82aa15333b32fbf3cfe630d8a73287e7eee
+  metadata.gz: 7778366b484f614248c91c33d9aa3e01377c6861408277e5f9e49391e0b5640edcc3dee685c7ed415484bc0a3f2f9c3a2aff852bbbba777b9087e7e49e8803c0
+  data.tar.gz: 1b0d6f6148183a97326edcf11c1a0b7b140573b0d758d157c5c06d43947c4e2ca26831c24973f5f56688b06fae421188e44648a94bcde84c81ba27ebd7d10319

data/README.md

@@ -12,7 +12,155 @@ flow-lite gem - (yet) another (lite) workflow engine; let's you define your work
 
 ## Usage
 
-To be done
+
+Define the workflow steps in a Flowfile. Example:
+
+
+``` ruby
+step :first_step do
+  puts "first_step"
+  second_step    # note: you can call other steps like methods
+end
+
+step :second_step do
+  puts "second_step"
+  third_step
+end
+
+step :third_step do
+  puts "third_step"
+end
+```
+
+And than use the `flow` command line tool to run a step.
+Example:
+
+```
+$ flow first_step
+```
+
+Note: By default the `flow` command line tool reads in the `Flowfile`. Use `-f/--flowfile` option to use a different file.
+
+
+That's it for now.
+
+
+
+## Backstage Internals / Inside Flowfiles
+
+
+If you read in a `Flowfile` the flow machinery
+builds a new (regular) class derived from `Flow::Base`
+and every step becomes a (regular) method. Example:
+
+``` ruby
+require 'flow-lite'
+
+flowfile = Flow::Flowfile.load( <<TXT )
+  step :hello do
+    puts "Hello, world!"
+  end
+
+  step :hola do
+    puts "¡Hola, mundo!"
+  end
+TXT
+
+flow = flowfile.flow   # (auto-)builds a flow class (see Note 1)
+                       # and constructs/returns an instance
+flow.hello             #=> "Hello, world!"
+flow.hola              #=> "¡Hola, mundo!"
+
+# or use ruby's (regular) message/metaprogramming machinery
+flow.send( :hello )    #=> "Hello, world!"
+flow.send( :hola  )    #=> "¡Hola, mundo!"
+# or try
+flow.class.instance_methods.grep( /^step_/ ) #=> [:step_hello, :step_hola]
+# ...
+```
+
+Note 1:  The Flowfile "source / configuration":
+
+``` ruby
+step :hello do
+  puts "Hello, world!"
+end
+
+step :hola do
+  puts "¡Hola, mundo!"
+end
+```
+
+gets used to (auto-) build (via metaprogramming) a flow class like:
+
+``` ruby
+class Greeter < Flow::Base
+  def hello
+    puts "Hello, world!"
+  end
+  alias_method :step_hello, :hello
+
+  def hola
+    puts "¡Hola, mundo!"
+  end
+  alias_method :step_hola, :hola
+end
+```
+
+
+
+**Tips & Tricks**
+
+Auto-include pre-build / pre-defined steps. Use a (regular) Module e.g.:
+
+``` ruby
+module GitHubActions
+  def setup
+     # setup ssh
+     ssh_key  = ENV['SSH_KEY']
+     ssh_path = File.expand_path( '~/.ssh' )
+
+     FileUtils.mkdir_p( ssh_path )   # make sure path exists
+     File.open( "#{ssh_path}/id_rsa", 'w' ) { |f| f.write( ssh_key ) }
+     File.chmod( 0600, "#{ssh_path}/id_rsa" )
+
+     # setup git
+     user_name  = ENV['GITHUB_NAME']  || 'you'
+     user_email = ENV['GITHUB_EMAIL'] || 'you@example.com'
+
+     Git.config( 'user.name',  user_name,  global: true )
+     Git.config( 'user.email', user_email, global: true )
+
+     # ...
+  end
+  # optional - for auto-discovery add a step alias
+  alias_method :step_setup, :setup
+end
+```
+
+and than use (regular) include e.g.:
+
+``` ruby
+class Flow::Base
+  include GitHubActions
+end
+```
+
+Now all your flows can (re)use `setup` or any other methods you define.
+
+
+
+
+
+## Installation
+
+Use
+
+    gem install flow-lite
+
+or add to your Gemfile
+
+    gem 'flow-lite'
 
 
 

data/lib/flow-lite.rb

@@ -40,7 +40,20 @@ end # class Step
 
 
 class Base    ## base class for flow class (auto)-constructed/build from flowfile
-end
+  def self.define_step( step )
+    name = step.names[0]
+    puts "    adding step  >#{name}<..."
+    define_method( name, &step.block )
+    alias_method( :"step_#{name}", name )  ## (auto-)add step_<name> alias
+
+    alt_names = step.names[1..-1]
+    alt_names.each do |alt_name|
+      puts "      adding alias >#{alt_name}< for >#{name}<..."
+      alias_method( alt_name, name )
+    end
+  end
+end  # class Base
+
 
 
 class Flowfile
@@ -66,20 +79,12 @@ class Flowfile
 
   def build_flow_class
     puts "  building flow class..."
-    flowfile = self
-    klass = Class.new( Base ) do
-      flowfile.steps.each_with_index do |step,i|
-        name = step.names[0]
-        puts "    adding step #{i+1}/#{flowfile.steps.size} >#{name}<..."
-        define_method( name, &step.block )
-
-        alt_names = step.names[1..-1]
-        alt_names.each do |alt_name|
-          puts "      adding alias >#{alt_name}< for >#{name}<..."
-          alias_method( alt_name, name )
-        end
-      end
+    klass = Class.new( Base )
+
+    steps.each do |step|
+      klass.define_step( step )
     end
+
     klass
   end
 

data/lib/flow-lite/version.rb

@@ -1,8 +1,8 @@
 module FlowLite
 
   MAJOR = 0    ## todo: namespace inside version or something - why? why not??
-  MINOR = 0
-  PATCH = 1
+  MINOR = 1
+  PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flow-lite
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Gerald Bauer