hackboxen 0.1.2 → 0.1.3

data/CHANGELOG.textile

@@ -40,6 +40,10 @@ h3. Version 0.1.1
 
 * A hackbox __name__ is now separate from a dataset __protocol__. Namespaces are still shared for organizational purposes, but a protocol directory is no longer created for the output. 
 
+h3. Version 0.1.3
+
+* The tasks @hb:endpoint@ and @hb:icss@ can now move multiple files, instead of just one.
+
 h3. Still Needing
 
 * Full spec coverage for the hackboxen library.

data/README.textile

@@ -58,7 +58,7 @@ The hackbox output directory is where all of the data that a hackbox acquires, r
                 ├── ripd
                 │   └── bnc_download.zip
                 └── env
-                    └── working_environment.json         
+                    └── working_config.json         
 </code></pre>
 
 * @fixd/@: **(required)** See the output interface described below.
@@ -66,7 +66,7 @@ The hackbox output directory is where all of the data that a hackbox acquires, r
 * @rawd/@: **(optional)** This will contain all intermediate data processing outputs.
 * @ripd/@: **(required)** This will contain virginal downloaded source data adhering to the directory structure from which it was pulled.
 * @env/@:  **(required)** This directory contains a file describing the environment in which the hackbox was run.
-** @working_environment.json@: **(required)** All runtime config metadata used to generate the schema and output data.
+** @working_config.json@: **(required)** All runtime config metadata used to generate the schema and output data.
 
 Engine and output directories are generally created dynamically and are not meant to be archival.
 
@@ -124,9 +124,9 @@ The Hackboxen library depends on the following gems: "configliere":http://github
 
 h3. Creating a Hackbox
 
-Hackboxen comes with scaffold task that creates a template hackbox for you. Required arguments are @--namespace=@ and @--protocol=@. Optional arguments are @--targets=@.
+Hackboxen comes with scaffold task that creates a template hackbox for you. Required arguments are @--namespace=@ and @--hackbox_name=@. Optional arguments are @--protocol=@ and @--targets=@. The @protocol@ will default to the @hackbox_name@ unless otherwise specified. 
 
-<pre><code>hb-scaffold --namespace=foo.bar.baz --protocol=qux --targets=catalog,mysql
+<pre><code>hb-scaffold --namespace=foo.bar.baz --hackbox_name=qux --targets=catalog,mysql
 </code></pre>
 
 This will create the following directories and files:

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/hackboxen.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hackboxen}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["kornypoet", "Ganglion", "bollacker"]
-  s.date = %q{2011-07-08}
+  s.date = %q{2011-07-11}
   s.description = %q{A simple framework to assist in standardizing the data-munging input/output process.}
   s.email = %q{travis@infochimps.com}
   s.executables = ["hb-install", "hb-scaffold", "hb-runner"]
@@ -57,13 +57,14 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/infochimps/hackboxen}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{A simple framework to assist in standardizing the data-munging input/output process.}
   s.test_files = [
     "spec/install_spec.rb"
   ]
 
   if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/lib/hackboxen/tasks/endpoint.rb

@@ -3,11 +3,10 @@ module HackBoxen
 
     desc "Copy an endpoint.rb file to the output code directory if the endpoint exists"
     task :endpoint => ['hb:create_required_paths'] do
-      endpoint = "#{WorkingConfig[:protocol]}_endpoint.rb"
-      srcfile  = File.join(path_to(:hb_engine), endpoint)
-      if File.exists? srcfile
+      endpoints = Dir[File.join(path_to(:hb_engine), '**/*_endpoint.rb')]
+      endpoints.each do |srcfile|
         HackBoxen.current_fs.mkpath path_to(:code_dir)
-        destfile = File.join(path_to(:code_dir), endpoint)
+        destfile = File.join(path_to(:code_dir), File.basename(srcfile))
         HackBoxen.current_fs.cp(srcfile, destfile)
       end
     end

data/lib/hackboxen/tasks/icss.rb

@@ -3,11 +3,13 @@ module HackBoxen
 
     desc "Copy the Icss file to the output directory in the filesystem specified in the WorkingConfig"
     task :icss => ['hb:create_required_paths'] do
-      icss_yaml   = File.join(path_to(:hb_config), "#{WorkingConfig[:protocol]}.icss.yaml")
-      if File.exists? icss_yaml
-        icss      = YAML.load(File.read icss_yaml)
-        icss_json = File.join(path_to(:fixd_dir), "#{WorkingConfig[:protocol]}.icss.json")
-        HackBoxen.current_fs.open(File.join(icss_json), 'w') { |f| f.puts icss.to_json }
+      icss_yamls    = Dir[File.join(path_to(:hb_config), '**/*.icss.yaml')]
+      icss_yamls.each do |icss_yaml|
+        icss_hsh    = YAML.load(File.read(icss_yaml))
+        if icss_hsh
+          icss_json = File.join(path_to(:fixd_dir), "#{icss_hsh['protocol']}.icss.json")
+          HackBoxen.current_fs.open(File.join(icss_json), 'w') { |f| f.puts icss_hsh.to_json }
+        end
       end
     end
 

data/lib/hackboxen/tasks/scaffold.rb

@@ -7,17 +7,21 @@ machine_config = '/etc/hackbox/hackbox.yaml'
 install_config = File.join(ENV['HOME'], '.hackbox/hackbox.yaml')
 
 Settings.use :commandline, :config_file
-Settings.define :namespace, :required => true
-Settings.define :protocol,  :required => true
-Settings.define :coderoot,  :required => true
-Settings.define :targets,   :default  => 'catalog'
+Settings.define :namespace,    :required => true
+Settings.define :hackbox_name, :required => true
+Settings.define :protocol
+Settings.define :coderoot,     :required => true
+Settings.define :targets,      :default  => 'catalog'
 Settings.read(machine_config) if File.exists? machine_config
 Settings.read(install_config) if File.exists? install_config
 Settings.resolve!
 
+# Have the hackbox name be a default for the protocol if unspecified
+Settings[:protocol] = Settings[:hackbox_name] unless Settings[:protocol]
+
 # Hackbox directories to be created
 coderoot = Settings[:coderoot]
-hackbox  = File.join(coderoot, Settings[:namespace].gsub(/\./,'/'), Settings[:protocol])
+hackbox  = File.join(coderoot, Settings[:namespace].gsub(/\./,'/'), Settings[:hackbox_name])
 engine   = File.join(hackbox, 'engine')
 config   = File.join(hackbox, 'config')
 
@@ -34,12 +38,12 @@ templates   = File.join(hb_lib_dir, 'lib/hackboxen/template')
 
 # Create a basic endpoint if apeyeye was specified as a target
 file endpoint, [:config] => engine do |t, args|
-  HackBoxen::Template.new(File.join(templates, "endpoint.rb.erb"), endpoint, args[:config]).substitute!
+  HackBoxen::Template.new(File.join(templates, 'endpoint.rb.erb'), endpoint, args[:config]).substitute!
 end
 
 # Create a basic hackbox Rakefile
 file rakefile => hackbox do
-  HackBoxen::Template.new(File.join(templates, "Rakefile.erb"), rakefile, {}).substitute!
+  HackBoxen::Template.new(File.join(templates, 'Rakefile.erb'), rakefile, {}).substitute!
 end
 
 # Create a basic executable hackbox main file
@@ -50,8 +54,12 @@ end
 
 # Create a basic config file
 file config_yml => config do
-  basic_config = { 'namespace' => Settings[:namespace], 'protocol'  => Settings[:protocol] }
-  HackBoxen::Template.new(File.join(templates, "config.yaml.erb"), config_yml, basic_config).substitute!
+  basic_config = {
+    'namespace'    => Settings[:namespace],
+    'ruby_version' => RUBY_VERSION,
+    'hb_version'   => Gem.source_index.find_name('swineherd').first.version.to_s
+  }
+  HackBoxen::Template.new(File.join(templates, 'config.yaml.erb'), config_yml, basic_config).substitute!
 end
 
 # Create a basic icss file
@@ -62,7 +70,7 @@ file icss_yml => config do
     'protocol'  => Settings[:protocol],
     'targets'   => targets
   }
-  HackBoxen::Template.new(File.join(templates, "icss.yaml.erb"), icss_yml, basic_config).substitute!
+  HackBoxen::Template.new(File.join(templates, 'icss.yaml.erb'), icss_yml, basic_config).substitute!
   Rake::Task[endpoint].invoke(basic_config) if targets.include? 'apeyeye'
 end
 

data/lib/hackboxen/template/Rakefile.erb

@@ -13,7 +13,7 @@ task :get_data do
   #
 end
 
-task :default => ['hb:create_working_config', 'hb:icss', 'hb:endoint', :get_data, 'hb:init']
+task :default => ['hb:create_working_config', 'hb:icss', 'hb:endpoint', :get_data, 'hb:init']
 #
 # hb:create_working_config makes establishes all required directories and serializes out all
 # configuration options into env/working_config.json. This task is required.

data/lib/hackboxen/template/config.yaml.erb

@@ -4,7 +4,11 @@
 # during the execution of a hackbox should be put in here.
 #
 namespace: <%= namespace %>
-protocol: <%= protocol %>
 filesystem_scheme: file
 under_consideration: true # This flag is set to true for initial publishing, then removed when fully complete
 update_frequency: monthly # How often the data is refreshed
+requires:
+  language:
+    ruby: <%= ruby_version %>
+    gems:
+    - hackboxen: <%= hb_version %>

data/lib/hackboxen/template/main.erb

@@ -16,12 +16,13 @@ inputdir  = ARGV[0]
 outputdir = ARGV[1]
 
 #
-# Ruby example: read in the working_environment.json file in env/ into a ruby hash
+# Ruby example: read in the working_config.json file in env/ into a ruby hash
 # (same as a javascript associative array, a java hashmap, a python dictionary, etc)
 # called 'options' to access the configuration settings used to execute the Rakefile
 #
+require 'rubygems'
 require 'json'
-options = JSON.parse(File.read(File.join(inputdir, "env", "working_environment.json")))
+options = JSON.parse(File.read(File.join(inputdir, "env", "working_config.json")))
 
 #
 # If you require 'hackboxen' you can access the default paths utility method

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hackboxen
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.1.2
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - kornypoet
@@ -12,84 +17,115 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-08 00:00:00 -05:00
+date: 2011-07-11 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: swineherd
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 0
+        - 4
         version: 0.0.4
   type: :runtime
+  name: swineherd
   prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: configliere
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 4
+        - 6
         version: 0.4.6
   type: :runtime
+  name: configliere
   prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rake
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
         version: 0.8.7
   type: :runtime
+  name: rake
   prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: shoulda
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :development
+  name: shoulda
   prerelease: false
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: bundler
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
         version: 1.0.0
   type: :development
+  name: bundler
   prerelease: false
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: jeweler
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
         version: 1.5.2
   type: :development
+  name: jeweler
   prerelease: false
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: rcov
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :development
+  name: rcov
   prerelease: false
   version_requirements: *id007
 description: A simple framework to assist in standardizing the data-munging input/output process.
@@ -153,7 +189,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 265087323753599067
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -162,11 +198,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A simple framework to assist in standardizing the data-munging input/output process.