goz 0.0.2

data/.gitignore

@@ -0,0 +1,9 @@
+.*.swp
+*.gem
+.bundle
+coverage/
+Gemfile.lock
+goz.log
+html/
+out.txt
+pkg/*

data/Gemfile

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

data/HISTORY.rdoc

@@ -0,0 +1,12 @@
+= Goz History
+
+== 2012-03-08 v0.0.2
+
+* Added +Goz::Cache+
+
+
+== 2012-03-02 v0.0.1
+
+* First public release
+* Added +Goz::Logger+
+

data/README.rdoc

@@ -0,0 +1,33 @@
+= Goz - Generic self-service provisioning system
+  
+== Usage
+
+
+  # Cache
+  require 'goz/cache'
+  Goz::Cache.instance do |cache|
+    ... do stuff ...
+  end
+
+  # Logger
+  require 'goz/logger'
+  Goz::Logger.instance('MyApp') do |logger|
+    ... do stuff ...
+  end
+
+== See Also
+
+Goz::Cache, Goz::Logger
+
+== Author
+
+blair christensen. <mailto:blair.christensen@gmail.com>
+
+== Homepage
+
+https://github.com/blairc/goz/
+
+== See Also
+
+https://github.com/blairc/goz-rails/
+

data/Rakefile

@@ -0,0 +1,24 @@
+require 'bundler/gem_tasks'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rdoc-readme/rake_task'
+require 'rdoc/task'
+
+%w{ coverage goz.log html out.txt pkg }.each { |p| CLEAN.include(p) }
+%w{ build install rdoc test }.each   { |t| task t.to_sym => [ 'rdoc:readme' ] }
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs       << 'test'
+  t.test_files =   FileList['test/test*.rb']
+  t.verbose    =   true
+end
+
+RDoc::Readme::RakeTask.new 'lib/goz.rb', 'README.rdoc'
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = 'README.rdoc'
+  rdoc.rdoc_files.include('README.rdoc', 'lib/**/*.rb', 'doc/*.txt')
+end
+

data/goz.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'goz/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'goz'
+  s.version     = Goz::VERSION
+  s.authors     = ['blair christensen']
+  s.email       = ['blair.christensen@gmail.com']
+  s.homepage    = 'https://github.com/blairc/goz/'
+  s.summary     = %q{Generic self-service provisioning system}
+  s.description = %q{Generic self-service provisioning system}
+
+  s.rubyforge_project = 'goz'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rdoc'
+  s.add_development_dependency 'rdoc-readme', '~> 0.1.2'
+  s.add_development_dependency 'simplecov'
+end

data/lib/goz.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+require 'goz/cache'
+require 'goz/logger'
+require 'goz/version'
+
+# 
+# = Goz - Generic self-service provisioning system
+#   
+# == Usage
+#
+#
+#   # Cache
+#   require 'goz/cache'
+#   Goz::Cache.instance do |cache|
+#     ... do stuff ...
+#   end
+#
+#   # Logger
+#   require 'goz/logger'
+#   Goz::Logger.instance('MyApp') do |logger|
+#     ... do stuff ...
+#   end
+#
+# == See Also
+#
+# Goz::Cache, Goz::Logger
+#
+# == Author
+#
+# blair christensen. <mailto:blair.christensen@gmail.com>
+#
+# == Homepage
+#
+# https://github.com/blairc/goz/
+#
+# == See Also
+#
+# https://github.com/blairc/goz-rails/
+#
+module Goz
+  # Your code goes here...
+end
+

data/lib/goz/cache.rb

@@ -0,0 +1,136 @@
+# encoding: utf-8
+
+require 'goz/cache/hash_store'
+
+module Goz # :nodoc:
+ 
+  # 
+  # = Goz::Cache - Generic cache
+  #   
+  # == Usage
+  #
+  #   require 'goz/cache'
+  #
+  #   cache = Goz::Cache.new do |cache|
+  #     # block initialization with default cache
+  #   end
+  #
+  #   cache = Goz::Cache.new(ActiveSupport::Cache::MemoryStore.new) do |cache|
+  #     # block initialization with custom cache
+  #   end
+  #
+  #   # initialization with default cache
+  #   cache = Goz::Cache.new
+  #
+  #   # initialization with custom cache
+  #   cache = Goz::Cache.new(ActiveSupport::Cache::MemoryStore.new)
+  #
+  #   # Write to cache
+  #   cache.write(key, value)
+  #
+  #   # Read from cache
+  #   cache.read(key)
+  #
+  #   # Delete from cache if key exists.
+  #   cache.delete(key) if cache.exist?(key)
+  #
+  #   # Clear the cache
+  #   cache.clear
+  #
+  # == Author
+  #
+  # blair christensen. <mailto:blair.christensen@gmail.com>
+  #
+  # == Homepage
+  #
+  # https://github.com/blairc/goz/
+  #
+  class Cache
+
+    #
+    # Default cache implementation to use.
+    #
+    DEFAULT_CACHE = Goz::Cache::HashStore.new
+
+
+    @@caches = {}
+
+
+    #
+    # Create (if necessary) and return Goz::Cache instance.
+    #
+    # Params:
+    # +cache+:: (optional) Any +ActiveSupport::Cache::Store+ compatible class.  Defaults to +DEFAULT_CACHE+.
+    #
+    def self.instance( cache = DEFAULT_CACHE )
+      unless @@caches.key?(cache)
+        @@caches[cache] = self.new(cache)
+      end
+      yield @@caches[cache] if block_given?
+      @@caches[cache]
+    end
+
+    #
+    # Initialize Goz::Cache
+    #
+    # Params:
+    # +cache+:: (optional) Any +ActiveSupport::Cache::Store+ compatible class.  Defaults to +DEFAULT_CACHE+.
+    #
+    def initialize( cache = DEFAULT_CACHE )
+      @cache = cache
+      yield self if block_given?
+      self
+    end
+
+    #
+    # Empty cache.  Returns +true+ if successful.
+    #
+    def clear
+      @cache.clear
+    end
+
+    #
+    # Return true if +key+ deleted from cache.
+    #
+    # Params:
+    # +key+:: Name of key to delete.
+    #
+    def delete(key)
+      @cache.delete(key)
+    end
+
+    #
+    # Return true if +key+ exists in cache.
+    #
+    # Params:
+    # +key+:: Name of key
+    #
+    def exist?(key)
+      @cache.exist?(key)
+    end
+
+    #
+    # Return value from cache or +nil+.
+    #
+    # Params:
+    # +key+:: Get value for this key.
+    #
+    def read(key)
+      @cache.read(key)
+    end
+
+    #
+    # Add +value+ to cache with +key+.  Returns value added to cache.
+    #
+    # Params:
+    # +key+:: Associate value with this this key.
+    # +value+:: Value to add to cache.
+    #
+    def write(key, value)
+      @cache.write(key, value) ? value : nil
+    end
+
+  end # class Cache
+
+end # module Goz
+

data/lib/goz/cache/hash_store.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+
+module Goz # :nodoc:
+  class Cache # :nodoc
+
+    #
+    # = Goz::Cache::HashStore - Hash-based cache implementation.
+    #
+    # == See Also
+    #
+    # Goz::Cache, ActiveSupport::Cache::Store
+    #
+    # == Author
+    #
+    # blair christensen. <mailto:blair.christensen@gmail.com>
+    #
+    # == Homepage
+    #
+    # https://github.com/blairc/goz/
+    #
+    class HashStore < Hash
+
+      #
+      # Empty cache.  Returns +true+ if successful.
+      #
+      def clear
+        super ? true : false
+      end
+
+      #
+      # Return true if +key+ deleted from cache.
+      #
+      # Params:
+      # +key+:: Name of key to delete.
+      #
+      def delete(key)
+        super ? true : false
+      end
+
+      #
+      # Return true if +key+ exists in cache.
+      #
+      # Params:
+      # +key+:: Name of key
+      #
+      def exist?(key)
+        key?(key)
+      end
+
+      #
+      # Return value from cache or +nil+.
+      #
+      # Params:
+      # +key+:: Get value for this key.
+      #
+      def read(key)
+        self[key]
+      end
+
+      #
+      # Add +value+ to cache with +key+.  Returns value added to cache.
+      #
+      # Params:
+      # +key+:: Associate value with this this key.
+      # +value+:: Value to add to cache.
+      #
+      def write(key, value)
+        self[key] = value
+      end
+
+    end # class HashStore
+
+  end # class Cache
+end # module Goz
+

data/lib/goz/logger.rb

@@ -0,0 +1,141 @@
+# encoding: utf-8
+
+require 'logger'
+
+module Goz # :nodoc:
+ 
+  # 
+  # = Goz::Logger - Generic logger
+  #   
+  # == Usage
+  #
+  #   require 'goz/logger'
+  #
+  #   logger = Goz::Logger.new('MyApp') do |logger|
+  #     logger.debug('block initialization with default logger')
+  #   end
+  #
+  #   logger = Goz::Logger.new('MyApp')
+  #   logger.error('initialization with default logger')
+  #
+  #   logger = Goz::Logger.instance( 'MyApp', ::Logger.new($stdout) ) do |logger|
+  #     logger.fatal('instance initialization with custom logger')
+  #   end
+  #
+  #   logger = Goz::Logger.instance( 'MyApp', ::Logger.new($stdout) )
+  #   logger.info('instance initialization with custom logger')
+  #
+  #   logger.warn('warn example to cover all log severity levels')
+  #
+  # == Author
+  #
+  # blair christensen. <mailto:blair.christensen@gmail.com>
+  #
+  # == Homepage
+  #
+  # https://github.com/blairc/goz/
+  #
+  class Logger
+
+    #
+    # Default logfile to use.
+    #
+    DEFAULT_LOGFILE = $stdout
+
+    #
+    # Default logger to use.
+    #
+    DEFAULT_LOGGER  = ::Logger.new(DEFAULT_LOGFILE)
+
+
+    @@loggers = {}
+
+
+    #
+    # Create (if necessary) and return Goz::Logger instance.
+    #
+    # Params:
+    # +tag+:: Tag log messages with this +String+.
+    # +logger+:: (optional) Any +::Logger+ compatible class. Defaults to +DEFAULT_LOGGER+.
+    #
+    def self.instance( tag, logger = DEFAULT_LOGGER )
+      key = [ tag, logger ]
+      unless @@loggers.key?(key)
+        @@loggers[key] = self.new(tag, logger)
+      end
+      yield @@loggers[key] if block_given?
+      @@loggers[key]
+    end
+
+    #
+    # Initialize Goz::Logger
+    #
+    # Params:
+    # +tag+:: Tag log messages with this +String+.
+    # +logger+:: (optional) Any +::Logger+ compatible class. Defaults to +DEFAULT_LOGGER+.
+    #
+    def initialize( tag, logger = DEFAULT_LOGGER )
+      @logger = logger
+      @tag    = tag
+      # TODO Make configurable?
+      @logger.formatter = proc do |severity, datetime, progname, msg|
+        "#{datetime} #{severity} #{tag}: #{msg}\n"
+      end
+      yield self if block_given?
+      self
+    end
+
+    #
+    # Send +debug+ log message.
+    #
+    # Params:
+    # +message+:: +String+ message to send to logger.
+    #
+    def debug(message)
+      @logger.debug message
+    end
+
+    #
+    # Send +error+ log message.
+    #
+    # Params:
+    # +message+:: +String+ message to send to logger.
+    #
+    def error(message)
+      @logger.error message
+    end
+
+    #
+    # Send +fatal+ log message.
+    #
+    # Params:
+    # +message+:: +String+ message to send to logger.
+    #
+    def fatal(message)
+      @logger.fatal message
+    end
+
+    #
+    # Send info log message.
+    #
+    # Params:
+    # +message+:: +String+ message to send to logger.
+    #
+    def info(message)
+      @logger.info message
+    end
+
+    #
+    # Send warn log message.
+    #
+    # Params:
+    # +message+:: +String+ message to send to logger.
+    #
+    def warn(message)
+      @logger.warn message
+    end
+
+  end # class Logger
+
+end # module Goz
+

data/lib/goz/version.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+module Goz
+
+  #
+  # Goz version
+  #
+  VERSION = '0.0.2'
+
+end
+

data/test/test_goz.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+require 'simplecov'
+SimpleCov.start
+
+require 'goz'
+require 'test/unit'
+
+
+class TestGoz < Test::Unit::TestCase
+
+  def test_version
+    assert_equal  '0.0.2',  Goz::VERSION
+  end
+
+end
+

data/test/test_goz_cache.rb

@@ -0,0 +1,88 @@
+# encoding: utf-8
+
+require 'simplecov'
+SimpleCov.start
+
+require 'goz/cache'
+require 'test/unit'
+
+
+class TestGozCache < Test::Unit::TestCase
+
+  def setup
+    @cache = Goz::Cache.new
+  end
+
+  def test_default_initialization
+    blockable = false
+    cache     = Goz::Cache.new do |cache|
+      assert_kind_of  Goz::Cache, cache
+      blockable = true
+    end
+    assert         blockable,   'works as block'
+    assert_kind_of Goz::Cache, cache
+    assert_kind_of Goz::Cache, Goz::Cache.new
+  end
+
+  def test_initialization
+    blockable = false
+    cache     = Goz::Cache.new(@cache) do |cache|
+      assert_kind_of  Goz::Cache, cache
+      blockable = true
+    end
+    assert         blockable,   'works as block'
+    assert_kind_of Goz::Cache, cache
+    assert_kind_of Goz::Cache, Goz::Cache.new(@cache)
+  end
+
+  def test_default_instance
+    blockable = false
+    cache = Goz::Cache.instance do |cache|
+      assert_kind_of  Goz::Cache, cache
+      blockable = true
+    end
+    assert            blockable,    'works as block'
+    assert_kind_of    Goz::Cache,  cache
+    assert_kind_of    Goz::Cache,  Goz::Cache.instance
+    assert_equal      cache,       Goz::Cache.instance
+    assert_not_equal  cache,       Goz::Cache.instance(Array.new)
+  end
+
+  def test_instance
+    blockable = false
+    cache = Goz::Cache.instance(@cache) do |cache|
+      assert_kind_of  Goz::Cache, cache
+      blockable = true
+    end
+    assert            blockable,    'works as block'
+    assert_kind_of    Goz::Cache,  cache
+    assert_kind_of    Goz::Cache,  Goz::Cache.instance(@cache)
+    assert_equal      cache,       Goz::Cache.instance(@cache)
+    assert_not_equal  cache,       Goz::Cache.instance(Array.new)
+  end
+
+  def test_default_cache
+    assert_kind_of  Goz::Cache::HashStore,  Goz::Cache::DEFAULT_CACHE
+  end
+
+  def test_caching
+    key, value = :foo, :bar
+
+    assert_equal  false,  @cache.exist?(key)
+    assert_equal  false,  @cache.delete(key)
+
+    assert_equal  value,  @cache.write(key, value)
+    assert_equal  value,  @cache.read(key)
+    assert_equal  true,   @cache.exist?(key)
+    assert_equal  true,   @cache.delete(key)
+    assert_equal  false,  @cache.exist?(key)
+    assert_equal  nil,    @cache.read(key)
+
+    assert_equal  value,  @cache.write(key, value)
+    assert_equal  true,   @cache.exist?(key)
+    assert_equal  true,   @cache.clear
+    assert_equal  false,  @cache.exist?(key)
+  end
+
+end
+

data/test/test_goz_cache_hash_store.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+require 'simplecov'
+SimpleCov.start
+
+require 'goz/cache/hash_store'
+require 'test/unit'
+
+
+class TestGozCacheHashStore < Test::Unit::TestCase
+
+  def setup
+    @cache = Goz::Cache::HashStore.new
+  end
+
+  def test_default_initialization
+    assert_kind_of Goz::Cache::HashStore, @cache
+  end
+
+  def test_caching
+    key, value = :foo, :bar
+
+    assert_equal  false,  @cache.exist?(key)
+    assert_equal  false,  @cache.delete(key)
+
+    assert_equal  value,  @cache.write(key, value)
+    assert_equal  value,  @cache.read(key)
+    assert_equal  true,   @cache.exist?(key)
+    assert_equal  true,   @cache.delete(key)
+    assert_equal  false,  @cache.exist?(key)
+    assert_equal  nil,    @cache.read(key)
+
+    assert_equal  value,  @cache.write(key, value)
+    assert_equal  true,   @cache.exist?(key)
+    assert_equal  true,   @cache.clear
+    assert_equal  false,  @cache.exist?(key)
+  end
+
+end
+

data/test/test_goz_logger.rb

@@ -0,0 +1,90 @@
+# encoding: utf-8
+
+require 'simplecov'
+SimpleCov.start
+
+require 'goz/logger'
+require 'logger'
+require 'stringio'
+require 'test/unit'
+
+
+class TestGozLogger < Test::Unit::TestCase
+
+  def setup
+    @s      = StringIO.new
+    @logger = Logger.new(@s)
+    @tag    = self.class.name
+  end
+
+  def test_default_initialization
+    blockable = false
+    logger = Goz::Logger.new(@tag) do |logger|
+      assert_kind_of  Goz::Logger, logger
+      blockable = true
+    end
+    assert         blockable,   'works as block'
+    assert_kind_of Goz::Logger, logger
+    assert_kind_of Goz::Logger, Goz::Logger.new(@tag)
+  end
+
+  def test_initialization
+    blockable = false
+    logger = Goz::Logger.new(@tag, @logger) do |logger|
+      assert_kind_of  Goz::Logger, logger
+      blockable = true
+    end
+    assert         blockable,   'works as block'
+    assert_kind_of Goz::Logger, logger
+    assert_kind_of Goz::Logger, Goz::Logger.new(@tag, @logger)
+  end
+
+  def test_default_instance
+    blockable = false
+    logger = Goz::Logger.instance(@tag) do |logger|
+      assert_kind_of  Goz::Logger, logger
+      blockable = true
+    end
+    assert            blockable,    'works as block'
+    assert_kind_of    Goz::Logger,  logger
+    assert_kind_of    Goz::Logger,  Goz::Logger.instance(@tag)
+    assert_equal      logger,       Goz::Logger.instance(@tag)
+    assert_not_equal  logger,       Goz::Logger.instance('foo')
+  end
+
+  def test_instance
+    blockable = false
+    logger = Goz::Logger.instance(@tag, @logger) do |logger|
+      assert_kind_of  Goz::Logger, logger
+      blockable = true
+    end
+    assert            blockable,    'works as block'
+    assert_kind_of    Goz::Logger,  logger
+    assert_kind_of    Goz::Logger,  Goz::Logger.instance(@tag, @logger)
+    assert_equal      logger,       Goz::Logger.instance(@tag, @logger)
+    assert_not_equal  logger,       Goz::Logger.instance('foo')
+  end
+
+  def test_logging_within_block
+    [ :debug, :error, :fatal, :info, :warn ].each do |severity|
+      Goz::Logger.new(@tag, @logger) do |logger|
+        logger.send severity, "this is a #{ severity.to_s } message"
+        @s.rewind
+        rx = %r{^\d{4}\-\d{2}\-\d{2} \d{2}:\d{2}:\d{2} [+-]\d+ #{ severity.to_s.upcase } #{ @tag }: this is a #{ severity.to_s } message$}
+        assert_match rx, @s.readlines.last.chomp
+      end
+    end
+  end
+
+  def test_logging_outside_of_block
+    [ :debug, :error, :fatal, :info, :warn ].each do |severity|
+      logger = Goz::Logger.new(@tag, @logger)
+      logger.send severity, "this is a #{ severity.to_s } message"
+      @s.rewind
+      rx = %r{^\d{4}\-\d{2}\-\d{2} \d{2}:\d{2}:\d{2} [+-]\d+ #{ severity.to_s.upcase } #{ @tag }: this is a #{ severity.to_s } message$}
+      assert_match rx, @s.readlines.join.chomp
+    end
+  end
+
+end
+

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: goz
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- blair christensen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-08 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70286441430580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70286441430580
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70286441430140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70286441430140
+- !ruby/object:Gem::Dependency
+  name: rdoc-readme
+  requirement: &70286441429640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :development
+  prerelease: false
+  version_requirements: *70286441429640
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70286441429220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70286441429220
+description: Generic self-service provisioning system
+email:
+- blair.christensen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- HISTORY.rdoc
+- README.rdoc
+- Rakefile
+- goz.gemspec
+- lib/goz.rb
+- lib/goz/cache.rb
+- lib/goz/cache/hash_store.rb
+- lib/goz/logger.rb
+- lib/goz/version.rb
+- test/test_goz.rb
+- test/test_goz_cache.rb
+- test/test_goz_cache_hash_store.rb
+- test/test_goz_logger.rb
+homepage: https://github.com/blairc/goz/
+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: -4339046031995261735
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4339046031995261735
+requirements: []
+rubyforge_project: goz
+rubygems_version: 1.8.7
+signing_key: 
+specification_version: 3
+summary: Generic self-service provisioning system
+test_files:
+- test/test_goz.rb
+- test/test_goz_cache.rb
+- test/test_goz_cache_hash_store.rb
+- test/test_goz_logger.rb