keminglabs-fox-rubby 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/README.md

@@ -0,0 +1,9 @@
+# Fox
+
+Rubbygem that makes it easy to create a builder process for use with the Fox build tool.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'keminglabs-fox-rubby'

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/examples/minimal.rb

@@ -0,0 +1,7 @@
+require "keminglabs-fox-rubby"
+
+Fox.register "hello" do |req|
+  "hello world built!"
+end
+
+Fox.start!

data/examples/web_example.rb

@@ -0,0 +1,91 @@
+require 'fox'
+require 'tilt'
+require 'sass'
+
+# A builder process that compiles CSS from SASS.
+
+# Cases
+# 1. Success: built
+# 2. Fail: threw an exception
+# 3. Abort: dependencies aren't there
+def build_css(request)
+  # get source from target
+  source = "src/sass/" + request[:target].gsub(/\.css$/, '.sass')
+
+  # find out if theres dependencies
+  t = Tilt.new(source)
+  #Not sure if this is the right way to reach in and get the SASS engine...my Rubby-fu is weak.
+  dependencies = t.instance_variable_get(:@engine).dependencies.map{|x| x.options[:filename]}
+
+  # find out if all dependencies are met
+  if Fox.ensure(request[:socket], dependencies)
+    # Build it
+    begin
+      res = t.render nil
+
+      # Success
+      return {
+        :exit   => :succeed,
+        # optional
+        :result => res,
+        :log    => "Successfully built #{request[:target]}",
+        :tags   => ["web"]
+      }
+    rescue
+      # Failure
+      return {
+        :exit   => :fail,
+        # optional
+        :log    => "Failed to build #{request[:target]}",
+        :tags   => ["web"]
+      }
+    end
+  else
+    # Abort
+    return {
+      :exit   => :abort,
+      # optional
+      :log    => "Dependencies not met for #{request[:target]}",
+      :tags   => ["web"]
+    }
+  end
+end
+
+# Example of registering a handler for a target
+Fox.register "default.css" { |req| build_css(req) }
+
+Fox.register "target name" do |req|
+
+  ##Your build code
+
+  # general case: return a map:
+  #
+  # {
+  #   :exit   => :succeed,
+  #   :result => "the built target...",
+  #   # optional
+  #   :log    => "Dependencies not met for #{request[:target]}",
+  #   :tags   => ["web"]
+  # }
+
+  # specific case: return just a successful result or nil.
+  #
+  # "my result"
+
+  # specific case: succeed with log message
+  #
+  # "my result", "log..."
+
+  # If your code needs to ensure that dependencies exist before continuing, use this
+  #
+  #     Fox.ensure socket, deps
+  #
+  # (It will throw an exception that's caught by the rubbygem, which will return an abort map on your behalf)
+
+  # If your build fails for some other reason, feel free to raise hell:
+  #
+  #     raise "hell!"
+  #
+  # the rubbygem will catch and return a build failure map for you.
+  
+end

data/keminglabs-fox-rubby.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'keminglabs-fox-rubby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "keminglabs-fox-rubby"
+  spec.version       = Fox::VERSION
+  spec.authors       = ["Kevin J. Lynagh"]
+  spec.email         = ["kevin@keminglabs.com"]
+  spec.description   = "A rubbygem that makes it easy to write builder processes for the Fox build tool."
+  spec.summary       = "Fox"
+  spec.homepage      = "https://github.com/lynaghk/fox"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ffi-rzmq"
+  
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/keminglabs-fox-rubby/version.rb

@@ -0,0 +1,3 @@
+module Fox
+  VERSION = "0.0.1"
+end

data/lib/keminglabs-fox-rubby.rb

@@ -0,0 +1,128 @@
+require "keminglabs-fox-rubby/version"
+require "ffi-rzmq"
+require "json"
+require "fileutils"
+
+module Fox
+
+  class Abort < Exception
+  end
+
+  SockPath = "fox"
+  Context = ZMQ::Context.new(1)
+  Poller = ZMQ::Poller.new
+
+  # Map of socket -> {path, handler}
+  @handlers = {}
+
+  #Connects to Fox server via ZeroMQ and ensures that all requested dependencies are met.
+  #If something isn't met, raises a special exception that's rescued by the main run loop and turned into an abort message.
+  def self._assert(raise_p, req, *dependencies)
+    deps = dependencies.flatten.uniq.compact
+    
+    return true if deps.empty?
+    
+    sock = Context.socket(ZMQ::REQ)
+    sock.connect req[:socket]
+    sock.send_string JSON.generate({target: req[:target], dependencies: deps})
+
+    res = ""
+    sock.recv_string res
+    if (res == "fox-abort")
+      if raise_p
+        raise Abort
+      else
+        false
+      end
+    else
+      true
+    end
+  end
+
+  
+  def self.assert(req, *dependencies)
+    self._assert true, req, dependencies
+  end
+
+  
+  def self.register(path, handler)
+    FileUtils.mkdir_p SockPath + "/" + File.dirname(path)
+    sock = Context.socket(ZMQ::REP)
+    sock.bind "ipc://#{SockPath}/#{path}.ipc"
+    @handlers[sock] = {handler: handler, path: path}
+    nil
+  end
+
+  
+  def self.start!
+    @handlers.each do |sock, h|
+      $stderr.puts "Registering handler at: #{h[:path]}"
+      Poller.register(sock, ZMQ::POLLIN)
+    end
+    
+    Signal.trap("INT") do
+      break
+      Context.terminate
+    end
+
+    loop do
+      Poller.poll(:blocking)
+      Poller.readables.each do |sock|
+        req = recv sock
+        msg = begin
+                parse_handler_response @handlers[sock][:handler].call(req)
+              rescue Abort => _
+                {exit: "abort"}
+              rescue Exception => e
+                pp e
+                $stderr.puts e
+                {exit: "fail", log: e.to_s}
+              end
+        $stderr.puts "#{msg[:exit]}: #{req[:target]}"
+        send! sock, msg
+      end
+    end
+  end
+
+  #TODO: do I really want to make things private?
+  #This is just a documentation issue, really.
+  private
+
+
+  def self.send!(sock, msg)
+    sock.send_string JSON.generate msg
+  end
+
+  
+  def self.recv(sock)
+    msg_str = ""
+    sock.recv_string msg_str
+    JSON.parse msg_str, symbolize_names: true
+  end
+
+
+  def self.parse_handler_response(res)
+    case res
+    when String # a successful build
+      {
+        exit: "succeed",
+        result: res
+      }
+
+    when Array  # a successful build with log messages
+      {
+        exit: "succeed",
+        result: res[0],
+        log: res[1]
+      }
+
+    when Hash   # a full map
+      if not (x.key?(:exit) or x.key?("exit"))
+        throw "Response needs :exit key with value one of (:succeed, :abort, :fail)"
+      end
+      res
+    end
+  end
+
+  
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: keminglabs-fox-rubby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kevin J. Lynagh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi-rzmq
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A rubbygem that makes it easy to write builder processes for the Fox
+  build tool.
+email:
+- kevin@keminglabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- examples/minimal.rb
+- examples/web_example.rb
+- keminglabs-fox-rubby.gemspec
+- lib/keminglabs-fox-rubby.rb
+- lib/keminglabs-fox-rubby/version.rb
+homepage: https://github.com/lynaghk/fox
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Fox
+test_files: []