ghaki-namer 2011.11.30.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Gerald Kalafut
+
+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

@@ -0,0 +1,23 @@
+= Ghaki Namer = Automatic file naming
+
+Ghaki Namer is a series of helpers that allow file naming by a set pattern.
+
+== Download
+
+The latest version of Ghaki Namer can be found at
+
+* git@github.com:ghaki/ghaki-namer.git
+
+== Installation
+
+The preferred method of installing Ghaki Namer is through its GEM file.
+
+  % [sudo] gem install ghaki-namer-1.0.0.gem
+
+== License
+
+Ghaki Namer is released under the MIT license.
+
+== Support
+
+Contact mailto:gerald@kalafut.org

data/VERSION

@@ -0,0 +1 @@
+2011.11.30.1

data/lib/ghaki/namer/base.rb

@@ -0,0 +1,80 @@
+############################################################################
+module Ghaki
+  module Namer
+    class Base
+
+      ######################################################################
+      TIME_STAMP_FMT = '%Y%m%d_%H%M%S'
+      RAND_STAMP_MAX = 65536 # FFFF+1
+      RAND_STAMP_FMT = '%04x'
+
+      ######################################################################
+      attr_accessor :time_stamp, :rand_stamp, :rand_stamp_max,
+        :ticket_generator
+
+      ######################################################################
+      def initialize opts={}
+        @time_stamp     = opts[:time_stamp]     || Time.now
+        @rand_stamp_max = opts[:rand_stamp_max] || RAND_STAMP_MAX
+        @rand_stamp     = opts[:rand_stamp]     || rand(@rand_stamp_max)
+        @ticket_generator = opts[:ticket_generator]
+      end
+
+      ######################################################################
+      def parse_names *get_pile
+        put_pile = []
+        get_pile.each do |item|
+          _parse_item put_pile, item
+        end
+        put_pile
+      end
+
+      ######################################################################
+      def ticket
+        @ticket ||= parse_names( *@ticket_generator).join('')
+      end
+
+      ######################################################################
+      def debug_dump out_file
+        out_file.box 'debug ' + self.class.to_s
+        out_file.reindent({
+          :time_stamp => self.time_stamp,
+          :rand_stamp => self.rand_stamp,
+          :rand_stamp_max => self.rand_stamp_max,
+          :ticket_generator => self.ticket_generator,
+        }.inspect)
+      end
+
+      ######################################################################
+      ######################################################################
+      private
+
+      ######################################################################
+      def _parse_item put_pile, item
+        case item
+        when String       then put_pile.push(item)
+        when :time_stamp  then put_pile.push( @time_stamp.strftime(TIME_STAMP_FMT) )
+        when :rand_stamp  then put_pile.push( RAND_STAMP_FMT % @rand_stamp )
+        when Array        then _parse_complex put_pile, *item
+        when Proc         then put_pile.push( item.call() )
+        else
+          raise ArgumentError, "Invalid Path Generator: #{item.class}"
+        end
+      end
+
+      ######################################################################
+      def _parse_complex put_pile, item, *info
+        case item
+        when :time_stamp  then put_pile.push( @time_stamp.strftime(info[0]) )
+        when :rand_stamp  then put_pile.push( info[0] % @rand_stamp )
+        when :format      then put_pile.push( info[0] % info[1] )
+        when Proc         then put_pile.push( item.call( *info ) )
+        else
+          raise ArgumentError, "Invalid Path Generator: #{item.class}"
+        end
+      end
+
+    end # class
+  end # namespace
+end # package
+############################################################################

data/lib/ghaki/namer/error.rb

@@ -0,0 +1,3 @@
+module Ghaki
+  class NamerError < RuntimeError; end
+end

data/lib/ghaki/namer/files/app.rb

@@ -0,0 +1,13 @@
+require 'ghaki/app/plugin'
+require 'ghaki/namer/files/base'
+
+module Ghaki #:nodoc:
+module Namer #:nodoc:
+module Files #:nodoc:
+
+class App < Ghaki::App::Plugin
+  app_plugin_make Base, :file_namer
+  app_plugin_link :file_namer
+end
+
+end end end

data/lib/ghaki/namer/files/base.rb

@@ -0,0 +1,142 @@
+require 'fileutils'
+require 'ghaki/namer/base'
+
+module Ghaki #:nodoc:
+module Namer #:nodoc:
+module Files #:nodoc:
+
+class Base < Namer::Base
+
+  ######################################################################
+  attr_accessor :path_generator, :base_generator,
+    :suffix_map, :filename_map
+
+  ######################################################################
+  def initialize opts={} ; super opts
+    @suffix_map = {}
+    @filename_map  = {}
+    @path_generator = opts[:path_generator] || []
+    @base_generator = opts[:base_generator] || []
+  end
+
+  ######################################################################
+  def debug_dump out_file; super
+    out_file.puts( {
+      :suffix_map => self.suffix_map,
+      :path_generator => self.path_generator,
+      :base_generator => self.base_generator,
+      :filename_map => self.filename_map,
+    }.inspect )
+  end
+
+  ######################################################################
+  def generate_filename key
+    cur_path = parse_names( *@path_generator )
+    cur_base = parse_names( *@base_generator ).
+      push( @suffix_map[key] ).join('.')
+    File.join( cur_path, cur_base )
+  end
+
+  ######################################################################
+  def create_working_dirs opts={}
+    @filename_map.values.each do |fname|
+      ::FileUtils.mkdir_p( File.dirname(fname), opts )
+    end
+    self
+  end
+
+  ######################################################################
+  # RESERVE FILE NAMES
+  ######################################################################
+
+  #---------------------------------------------------------------------
+  def reserve_file token, new_suffix
+    old_suffix = @suffix_map[token]
+    if old_suffix.nil?
+      @suffix_map[token] = new_suffix
+    elsif old_suffix != new_suffix
+      raise NamerError, "Inconsistent File Extension: #{token.to_s} (#{old_suffix}/#{new_suffix})"
+    end
+  end
+
+  #---------------------------------------------------------------------
+  def reserve_files list
+    list.each do |key,val| reserve_file key, val end
+    self
+  end
+
+  ######################################################################
+  # PUT FILENAMES USING OPTS
+  ######################################################################
+
+  #---------------------------------------------------------------------
+  def opt_put_file opts, token
+    put_file token, opts[token] if opts.has_key?(token)
+  end
+
+  #---------------------------------------------------------------------
+  def opt_put_files opts, *tokens
+    tokens.each do |token| opt_put_file token, opts end
+  end
+
+  ######################################################################
+  # PUT FILENAMES DIRECTLY
+  ######################################################################
+
+  #---------------------------------------------------------------------
+  def put_file token, new_fname
+    old_fname = @filename_map[token]
+    if old_fname.nil?
+      @filename_map[token] = new_fname
+    elsif old_fname != new_fname
+      raise NamerError, "Inconsistent Filenaming: #{token.to_s}"
+    end
+    new_fname
+  end
+
+  #---------------------------------------------------------------------
+  def put_files list
+    list.each do |key,val| put_file key, val end
+    self
+  end
+
+  ######################################################################
+  # FREEZE FILENAMES
+  ######################################################################
+
+  #---------------------------------------------------------------------
+  def freeze_file token
+    @filename_map[token] || put_file( token, generate_filename( token ) )
+  end
+
+  #---------------------------------------------------------------------
+  def freeze_files tokens
+    tokens.each do |token| freeze_file token end
+    self
+  end
+
+  #####################################################################
+  alias_method :get_file, :freeze_file
+
+  ######################################################################
+  # ASSIGNING FILE NAMES
+  ######################################################################
+
+  def assign_file token, suffix
+    reserve_file token, suffix
+    freeze_file token
+  end
+
+  ######################################################################
+  def assign_files list
+    list.each do |key,val| assign_file key, val end
+    self
+  end
+
+  ######################################################################
+  def file_named? token
+    @filename_map[token].nil?
+  end
+
+end
+end end end

data/lib/ghaki/namer/files/mixin.rb

@@ -0,0 +1,13 @@
+require 'ghaki/app/mixable'
+require 'ghaki/namer/files/app'
+
+module Ghaki #:nodoc:
+module Namer #:nodoc:
+module Files #:nodoc:
+
+module Mixin
+  include Ghaki::App::Mixable
+  app_mixin_accessor App, :file_namer
+end
+
+end end end 

data/spec/ghaki/namer/base_spec.rb

@@ -0,0 +1,88 @@
+############################################################################
+require 'ghaki/namer/base'
+
+############################################################################
+module Ghaki module Namer module BaseTesting
+describe Ghaki::Namer::Base do
+
+  ########################################################################
+  TIME_VAL = Time.at(1269258809) # "2010/03/22 04:53:29"
+  TIME_FMT = TIME_VAL.strftime(Ghaki::Namer::Base::TIME_STAMP_FMT)
+  RAND_VAL = 32456
+  RAND_FMT = Ghaki::Namer::Base::RAND_STAMP_FMT % RAND_VAL
+
+  ########################################################################
+  context 'object' do
+    subject {Ghaki::Namer::Base.new }
+    it { should respond_to :time_stamp }
+    it { should respond_to :rand_stamp }
+    it { should respond_to :rand_stamp_max }
+    it { should respond_to :parse_names }
+    it { should respond_to :ticket }
+    it { should respond_to :ticket_generator }
+  end
+
+  ########################################################################
+  describe '#new' do
+
+    context 'with specific options' do
+      MY_NOW = Time.now.to_i - 100
+      MY_NUM = 100
+      MY_MAX = 100
+      subject do
+        Ghaki::Namer::Base.new({
+          :time_stamp     => MY_NOW,
+          :rand_stamp     => MY_NUM,
+          :rand_stamp_max => MY_MAX,
+        })
+      end
+      specify { subject.time_stamp.should == MY_NOW }
+      specify { subject.rand_stamp.should == MY_NUM }
+      specify { subject.rand_stamp_max.should == MY_MAX }
+    end
+  end
+
+  ########################################################################
+  describe '#parse_names' do
+    subject do
+      Ghaki::Namer::Base.new({
+        :time_stamp => TIME_VAL,
+        :rand_stamp => RAND_VAL,
+      })
+    end
+    it 'should see time default' do
+      subject.parse_names(:time_stamp)[0].should == TIME_FMT
+    end
+    it 'should see rand default' do
+      subject.parse_names(:rand_stamp)[0].should == RAND_FMT
+    end
+    it 'should see time with format' do
+      subject.parse_names( [:time_stamp,'%Y/%m/%d'] )[0].should == '2010/03/22'
+    end
+    it 'should see rand with format' do
+      fmt = '%08d'
+      aft = fmt % RAND_VAL
+      subject.parse_names( [:rand_stamp,fmt] )[0].should == aft
+    end
+    it 'should see static values' do
+      out = subject.parse_names('ghaki','log')
+      out[0].should == 'ghaki'
+      out[1].should == 'log'
+    end
+    it 'should do complex formats' do
+      subject.parse_names( [:format,'%0.3s','phxlb13'] )[0].should == 'phx'
+    end
+    it 'should do simple lambdas' do
+      str = 'quack'
+      fun = lambda do 'quack' end
+      subject.parse_names(fun)[0].should == str
+    end
+    it 'should do complex lambdas' do
+      fun = lambda do |major,minor| major + '_' + minor end
+      subject.parse_names( [fun,'moo','12'] )[0].should == 'moo_12'
+    end
+  end
+
+end
+end end end
+############################################################################

data/spec/ghaki/namer/files/app_engine_spec.rb

@@ -0,0 +1,40 @@
+############################################################################
+require 'ghaki/app/engine'
+require 'ghaki/namer/files/app'
+
+############################################################################
+module Ghaki module App module EngineTesting
+
+SOURCE_MOD = Ghaki::Namer::Files::Base
+TARGET_MOD = Ghaki::App::Engine
+
+describe TARGET_MOD do
+
+  ######################################################################
+  context 'singleton' do
+    subject { TARGET_MOD.instance }
+    [ :file_namer,  :file_namer_opts,
+      :file_namer=, :file_namer_opts=,
+    ].each do |token|
+      it { should respond_to token }
+    end
+  end
+
+  ######################################################################
+  context 'singleton method' do
+
+    describe '#file_namer' do
+    subject { TARGET_MOD.instance.file_namer }
+      it { should be_an_instance_of(SOURCE_MOD) }
+    end
+
+    describe '#file_namer_opts' do
+    subject { TARGET_MOD.instance.file_namer_opts }
+      it { should be_an_instance_of(::Hash) }
+    end
+
+  end
+
+end
+end end end
+############################################################################

data/spec/ghaki/namer/files/app_fnamer_spec.rb

@@ -0,0 +1,36 @@
+############################################################################
+require 'ghaki/namer/files/app'
+
+############################################################################
+module Ghaki module Namer module Files module AppTesting
+
+APP_MOD  = Ghaki::Namer::Files::App
+BASE_MOD = Ghaki::Namer::Files::Base
+
+describe APP_MOD do
+  context 'singleton instance' do
+    subject { APP_MOD.instance }
+
+    it { should respond_to :file_namer }
+    it { should respond_to :file_namer= }
+    describe '#file_namer' do
+      subject { APP_MOD.instance.file_namer }
+      it { should be_an_instance_of(BASE_MOD) }
+    end
+
+    it { should respond_to :file_namer_opts }
+    it { should respond_to :file_namer_opts= }
+    describe '#file_namer_opts' do
+      subject { APP_MOD.instance.file_namer_opts }
+      it { should be_an_instance_of(::Hash) }
+      context 'defaults' do
+        # WORK GOES HERE
+      end
+    end
+
+    it { should respond_to :file_namer_defs }
+    it { should respond_to :file_namer_defs= }
+
+  end
+end
+end end end end

data/spec/ghaki/namer/files/base_spec.rb

@@ -0,0 +1,75 @@
+require 'ghaki/namer/files/base'
+
+module Ghaki module Namer module Files module BaseTesting
+  BASE_MOD = Ghaki::Namer::Files::Base
+describe BASE_MOD do
+
+  TIME_VAL = Time.at(1269258809).gmtime # "2010/03/22 11:53:29"
+  TIME_FMT = TIME_VAL.strftime(Ghaki::Namer::Base::TIME_STAMP_FMT)
+  RAND_VAL = 32456
+  RAND_FMT = Ghaki::Namer::Base::RAND_STAMP_FMT % RAND_VAL
+
+  ########################################################################
+  context 'object instance' do
+    subject { BASE_MOD.new }
+    it { should respond_to :create_working_dirs }
+    it { should respond_to :put_file }
+    it { should respond_to :put_files }
+    it { should respond_to :assign_file }
+    it { should respond_to :assign_files }
+    it { should respond_to :reserve_file }
+    it { should respond_to :reserve_files }
+    it { should respond_to :freeze_file }
+    it { should respond_to :freeze_files }
+    it { should respond_to :get_file }
+  end
+
+  ########################################################################
+  context 'name generation' do
+    subject do
+      BASE_MOD.new({
+        :time_stamp => TIME_VAL,
+        :rand_stamp => RAND_VAL,
+        :path_generator => [ '/ghaki/project', 'logs' ],
+        :base_generator => [:time_stamp]
+      })
+    end
+    describe '#reserve_file' do
+      it 'reserves file name' do
+        subject.reserve_file( :log_file, 'error.log' )
+        subject.get_file(:log_file).should == '/ghaki/project/logs/20100322_115329.error.log'
+      end
+    end
+    describe '#assign_file' do
+      it 'assign file name' do
+        subject.assign_file( :log_file, 'error.log' )
+        subject.get_file(:log_file).should == '/ghaki/project/logs/20100322_115329.error.log'
+      end
+    end
+    describe '#put_file' do
+      it 'stores file name' do
+        subject.put_file( :log_file, './error.txt' )
+        subject.get_file(:log_file).should == './error.txt'
+      end
+    end
+  end
+
+  ########################################################################
+  describe '#create_working_dirs' do
+    before(:all) do
+      @my_path = '/tmp/bogus'
+      @stor = BASE_MOD.new({
+        :path_generator => [@my_path],
+      }).assign_files({
+        :log_file => 'error.txt',
+      })
+      ::FileUtils.expects(:mkdir_p).with(@my_path,is_a(Hash)).once
+    end
+    it 'calls mkdir' do
+      @stor.create_working_dirs
+    end
+  end
+
+end
+end end end end
+############################################################################

data/spec/ghaki/namer/files/mixin_spec.rb

@@ -0,0 +1,27 @@
+############################################################################
+require 'ghaki/namer/files/mixin'
+
+############################################################################
+module Ghaki module Namer module Files module MixinTesting
+  MIX_MOD = Ghaki::Namer::Files::Mixin
+  BAS_MOD = Ghaki::Namer::Files::Base
+  describe MIX_MOD do
+
+    class MyClass
+      include MIX_MOD
+    end
+
+    context 'including objects' do
+      subject { MyClass.new }
+      it { should respond_to :file_namer }
+      it { should respond_to :file_namer= }
+    end
+
+    describe '#file_namer' do
+      subject { MyClass.new.file_namer }
+      specify { subject.should be_an_instance_of(BAS_MOD) }
+    end
+
+  end
+end end end end
+############################################################################

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'mocha'
+
+RSpec.configure do |cfg|
+  cfg.mock_with :mocha
+  cfg.color_enabled = true
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: ghaki-namer
+version: !ruby/object:Gem::Version
+  version: 2011.11.30.1
+  prerelease: 
+platform: ruby
+authors:
+- Gerald Kalafut
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-30 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ghaki-app
+  requirement: &79714500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2011.11.29.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *79714500
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &79714280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: *79714280
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &79714050 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: *79714050
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &79713820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.9.4
+  type: :development
+  prerelease: false
+  version_requirements: *79713820
+description: Series of helpers that allow file naming by a set pattern.
+email: gerald@kalafut.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- README
+files:
+- lib/ghaki/namer/error.rb
+- lib/ghaki/namer/base.rb
+- lib/ghaki/namer/files/mixin.rb
+- lib/ghaki/namer/files/app.rb
+- lib/ghaki/namer/files/base.rb
+- README
+- LICENSE
+- VERSION
+- spec/ghaki/namer/base_spec.rb
+- spec/ghaki/namer/files/base_spec.rb
+- spec/ghaki/namer/files/mixin_spec.rb
+- spec/ghaki/namer/files/app_fnamer_spec.rb
+- spec/ghaki/namer/files/app_engine_spec.rb
+- spec/spec_helper.rb
+homepage: http://ghaki.com/
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: ghaki-namer
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Automatic file naming
+test_files:
+- spec/ghaki/namer/base_spec.rb
+- spec/ghaki/namer/files/base_spec.rb
+- spec/ghaki/namer/files/mixin_spec.rb
+- spec/ghaki/namer/files/app_fnamer_spec.rb
+- spec/ghaki/namer/files/app_engine_spec.rb
+- spec/spec_helper.rb