jewelbox 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jewelbox.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TODO: Write your name
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# Jewelbox
+
+Useful Ruby utility classes that handle:
+
+- configuration
+- time stamp
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jewelbox'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jewelbox
+
+## Usage
+
+Service Configuration
+=====================
+
+If you want to keep your application configuration separate from Rails config,
+you might store your configuration in a YAML file under conf/ directory.
+
+1. Suppose you have "/opt/myrailsapp/current/conf/service.yml" that looks like:
+  
+   ---
+   service:
+     name: myrailsapp
+     read_port: 80
+     write_port: 81
+     num_workers: 4
+   section1:
+     directive1: true
+     directive2: 100
+     directive3:
+       key1: val1
+       key2: val2
+
+2. Access the configuration file like this:
+
+   # Load service.yml like this
+   Jewelbox::Config.load("conf/service.yml")
+   -or-
+   Jewelbox.service_init               # this will load "conf/service.yml"
+                                       # from current working directory
+   # Access service configuration
+   Jewelbox.config.service.name        => "myrailsapp"
+   Jewelbox.config.service.read_port   => 80
+   Jewelbox.config.service.write_port  => 81
+   Jewelbox.config.service.num_workers => 4
+   Jewelbox.config.section1.directive1 => true
+   Jewelbox.config.section1.directive2 => 100
+   Jewelbox.config.section1.directive3 => {"key1" => "val1", "key2" => "val2"}
+   Jewelbox.config.section1            => <Section> object
+
+   # You can dynamically add things to config or section objects
+   Jewelbox.config.add("section2", "directive1", "new val")
+   Jewelbox.config.add("section2", "directive2", {:a => 20})
+   Jewelbox.config.section2.add("directive3", 200)
+   Jewelbox.config.section2.directive1 => "new_val"
+   Jewelbox.config.section2.directive2 => returns the same object you added
+   Jewelbox.config.section2.directive3 => 200
+
+   # some automatic bonus configs
+   Jewelbox.config.service.root_dir    => "/opt/myrailsapp/current"
+   Jewelbox.config.service.conf_dir    => "/opt/myrailsapp/current/conf"
+   Jewelbox.config.service.log_dir     => "/opt/myrailsapp/current/log"
+   Jewelbox.config.service.bin_dir     => "/opt/myrailsapp/current/bin"
+
+3. And my unicorn configuration looks like this:
+ 
+   TBD
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,22 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake"
+require "rake/testtask"
+
+namespace :test do
+
+  Rake::TestTask.new(:unit) do |test|
+    test.libs << 'test'
+    test.pattern = '{test/unit/**/*_test.rb}'
+  end
+
+  Rake::TestTask.new(:all) do |test|
+    test.libs << 'test'
+    test.pattern = '{test/**/*_test.rb}'
+  end
+
+end
+
+task :test    => "test:unit"
+task :default => "test"
+

data/jewelbox.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/jewelbox/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Steve Jang"]
+  gem.email         = ["estebanjang@gmail.com"]
+  gem.description   = %q{A set of useful Ruby functions to be used when creating a new service or rails application}
+  gem.summary       = %q{Contains functions that support service configuration, useful ruby methods (such as eigenclass), and other functionality commonly used by Ruby services}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "jewelbox"
+  gem.require_paths = ["lib"]
+  gem.version       = Jewelbox::VERSION
+
+  gem.add_development_dependency('ruby-debug19')
+end

data/lib/jewelbox/config.rb

@@ -0,0 +1,102 @@
+require 'jewelbox/ext/object'
+require 'yaml'
+module Jewelbox
+
+  # === Description
+  # Configure the current process with the configuration items stored in
+  # conf/service.yml file from the current working directory.
+  #
+  # === Parameters
+  # None
+  #
+  # === Returns
+  # After this call, you can access the following configuration items
+  #
+  # Jewelbox.config.service.name     => name of the service (e.g. "taskmon")
+  # Jewelbox.config.service.root_dir => everything else is relative to this
+  # Jewelbox.config.service.conf_dir
+  # Jewelbox.config.service.log_dir
+  # Jewelbox.config.service.bin_dir
+  # Jewelbox.config.service.lib_dir
+  #
+  # Also anything that's in service.yml will be accessible from
+  # Jewelbox::Service.config object.
+  #
+  def self.service_init
+    @service_root = ENV['SERVICE_ROOT'] || Dir.pwd
+    Config.load(File.join(@service_root,'conf','service.yml'))
+    @config.add('service', 'root_dir', @service_root)
+    @config.add('service', 'conf_dir', File.join(@service_root, 'conf'))
+    @config.add('service', 'log_dir',  File.join(@service_root, 'log'))
+    @config.add('service', 'bin_dir',  File.join(@service_root, 'bin'))
+    @config.add('service', 'lib_dir',  File.join(@service_root, 'lib'))
+    @config
+  end
+
+  # === Description
+  # All configuration files can be accessed through this.
+  #
+  def self.config
+    @config ||= Config.new
+  end
+
+  # === Description
+  # Configuration object that represents ALL configuration items
+  # to be used by the current service process
+  #
+  class Config
+
+    # === Description 
+    # Read the given YAML file, and add its content to Jewelbox.config.
+    #
+    def self.load(yml_path)
+      abs_path = File.expand_path(yml_path)
+      h = YAML::load(File.read(yml_path))
+      h.each do |section, inner|
+        inner.each do |directive, v|
+          Jewelbox.config.add(section, directive, v)
+        end
+      end
+    end
+
+    # === Description
+    # Inner class that represents a section
+    #
+    class Section
+      def initialize(name)
+        @name = name
+        @data = {}
+      end
+      def add(key, value)
+        @data[key] = value
+        eigenclass.send(:define_method, key) { value }
+      end
+    end
+
+    def initialize # :nodoc:
+      @section = {}
+    end
+
+    # === Description
+    # Add a configuration item to configuration object
+    #
+    # === Parameters
+    # section_name::   [String] section name
+    # directive_name:: [String] directive name
+    # value::          [Object] configuration value
+    #
+    # === Returns
+    # Config object self
+    #
+    def add(section_name, directive_name, value)
+      section = @section[section_name]
+      if section.nil?
+        section = (@section[section_name] = Section.new(section_name))
+        eigenclass.send(:define_method, section_name) { section }
+      end
+      section.add(directive_name, value)
+      self
+    end
+
+  end # Config
+end # Jewelbox

data/lib/jewelbox/ext/object.rb

@@ -0,0 +1,7 @@
+class Object
+  def eigenclass
+    class << self
+      self
+    end
+  end
+end

data/lib/jewelbox/ext/time.rb

@@ -0,0 +1,7 @@
+require 'time'
+class Time
+  def iso_8601
+    strftime("%FT%T%z")
+  end
+end
+

data/lib/jewelbox/version.rb

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

data/lib/jewelbox.rb

@@ -0,0 +1,4 @@
+require "jewelbox/version"
+require "jewelbox/config"
+require "jewelbox/ext/object"
+require "jewelbox/ext/time"

data/test/unit/conf/additional.yml

@@ -0,0 +1,5 @@
+---
+section2:
+  directive1: false
+  directive2: 200
+

data/test/unit/conf/service.yml

@@ -0,0 +1,18 @@
+---
+service:
+  name: clocktower
+  webui_port: 80100
+  api_port: 80100
+  worker_port: 80101
+  num_workers: 4
+section1:
+  directive1: true
+  directive2: 100
+  directive3: "string x"
+  directive4: "string y"
+  directive5: ["array", "of", "strings"]
+  directive6:
+    key1: val1
+    key2: val2
+    key3: val3
+

data/test/unit/config_test.rb

@@ -0,0 +1,39 @@
+ENV['SERVICE_ROOT'] = File.expand_path(File.dirname(__FILE__))
+require 'minitest/autorun'
+require 'jewelbox'
+
+class JewelboxConfigTest < MiniTest::Unit::TestCase
+
+  def setup
+    Jewelbox.service_init
+  end
+
+  def test_service_config
+    assert_equal('clocktower', Jewelbox.config.service.name)
+    assert_equal(80100, Jewelbox.config.service.webui_port)
+    assert_equal(80100, Jewelbox.config.service.api_port)
+    assert_equal(80101, Jewelbox.config.service.worker_port)
+    assert_equal(4, Jewelbox.config.service.num_workers)
+    assert_equal(Jewelbox.config.service.root_dir + "/conf", Jewelbox.config.service.conf_dir)
+    assert_equal(Jewelbox.config.service.root_dir + "/log", Jewelbox.config.service.log_dir)
+    assert_equal(Jewelbox.config.service.root_dir + "/bin", Jewelbox.config.service.bin_dir)
+    assert_equal(Jewelbox.config.service.root_dir + "/lib", Jewelbox.config.service.lib_dir)
+  end
+
+  def test_section1
+    assert_equal(true, Jewelbox.config.section1.directive1)
+    assert_equal(100, Jewelbox.config.section1.directive2)
+    assert_equal("string x", Jewelbox.config.section1.directive3)
+    assert_equal("string y", Jewelbox.config.section1.directive4)
+    assert_equal(["array", "of", "strings"], Jewelbox.config.section1.directive5)
+    assert_equal({"key1" => "val1", "key2" => "val2", "key3" => "val3"}, Jewelbox.config.section1.directive6)
+  end
+
+  def test_section2
+    Jewelbox::Config.load(Jewelbox.config.service.conf_dir + "/additional.yml")
+    assert_equal(false, Jewelbox.config.section2.directive1)
+    assert_equal(200, Jewelbox.config.section2.directive2)
+  end
+
+end
+

data/test/unit/ext/object_test.rb

@@ -0,0 +1,19 @@
+require 'minitest/autorun'
+require 'jewelbox/ext/object'
+
+class MyTestClass
+end
+
+class JewelboxObjectTest < MiniTest::Unit::TestCase
+
+  def test_eigenclass
+    ec = MyTestClass.eigenclass
+    ec.send(:define_method, :test1) do |x|
+      return x + x
+    end
+    assert_equal(4, MyTestClass.test1(2))
+  end
+
+end
+
+

data/test/unit/ext/time_test.rb

@@ -0,0 +1,16 @@
+require 'minitest/autorun'
+require 'jewelbox/ext/time'
+
+class JewelboxTimeTest < MiniTest::Unit::TestCase
+
+  def setup
+    @t = Time.parse("2012-07-30T18:00:02-07:00")
+  end
+
+  def test_iso_8601
+    assert_equal("2012-07-30T18:00:02-0700", @t.iso_8601)
+  end
+
+end
+
+

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: jewelbox
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Steve Jang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &22659880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22659880
+description: A set of useful Ruby functions to be used when creating a new service
+  or rails application
+email:
+- estebanjang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jewelbox.gemspec
+- lib/jewelbox.rb
+- lib/jewelbox/config.rb
+- lib/jewelbox/ext/object.rb
+- lib/jewelbox/ext/time.rb
+- lib/jewelbox/version.rb
+- test/unit/conf/additional.yml
+- test/unit/conf/service.yml
+- test/unit/config_test.rb
+- test/unit/ext/object_test.rb
+- test/unit/ext/time_test.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1874784024432894432
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1874784024432894432
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Contains functions that support service configuration, useful ruby methods
+  (such as eigenclass), and other functionality commonly used by Ruby services
+test_files:
+- test/unit/conf/additional.yml
+- test/unit/conf/service.yml
+- test/unit/config_test.rb
+- test/unit/ext/object_test.rb
+- test/unit/ext/time_test.rb