filename 0.1.0 → 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a1de0199d6e088c7d3d5f25ccec790fe5d6a183
+  data.tar.gz: 9ca727622fa431fbe294459fc8d2b717e0b94c77
+SHA512:
+  metadata.gz: 7e4b09f62796ac810a689861558e89b71e7dc97a2b9a91e4101dd4c50093eab8823e686ec957f455dd93be4852564935a3f65bf8672290a6ed74a8cc2e2a88b6
+  data.tar.gz: ae6b3e89a1e4de2bc179437a579a1b1850d1792d9216f7179d9fa631b1a1d291d71241d98c994a7dde4cbb1aca30b75012556a0e728262163894a75ca785e639

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

@@ -1,13 +1,4 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
+source 'https://rubygems.org'
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "rspec", ">= 2.5.0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.2"
-  gem "rcov", ">= 0"
-end
+# Specify your gem's dependencies in filename.gemspec
+gemspec

data/README.md

@@ -188,6 +188,19 @@ We can use the variables in proc object for an option :format.
 In the above example we prepare the instance variable "@a = 3"
 and use @a in proc object specified by an option :format.
 
+### Two filters: :before and :after
+
+Before and after all generation processes, we can filter basename without extension.
+
+    require 'filename'
+    FileName.create("name.txt",
+                    :filter => {
+                    :before => lambda { |basename| "before_" + basename },
+                    :after => lambda { |basename| basename + "_after" }
+                },
+                :add => :prohibit, :path => :relative)
+    # => "before_name_after.txt"
+
 ### Options of FileName#new, FileName#create, and FileName.create
 
 If we set options of FileName#create to FileName#new,

data/Rakefile

@@ -1,50 +1,11 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "filename"
-  gem.homepage = "http://github.com/ytaka/filename"
-  gem.license = "GPLv3"
-  gem.summary = "Filename generator"
-  gem.description = "Create filename with sequential number or time string that is not duplicated."
-  gem.email = "d@ytak.info"
-  gem.authors = ["Takayuki YAMAGUCHI"]
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
-  #  gem.add_development_dependency 'rspec', '> 1.2.3'
-end
-Jeweler::RubygemsDotOrgTasks.new
+require "bundler/gem_tasks"
 
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
 end
 
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "filename #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+require "yard"
+YARD::Rake::YardocTask.new do |t|
+  t.files = ["lib/**/*.rb", "lib/**/ext/**/*.c"]
 end

data/filename.gemspec

@@ -1,70 +1,25 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'filename/version'
 
-Gem::Specification.new do |s|
-  s.name = %q{filename}
-  s.version = "0.1.0"
+Gem::Specification.new do |spec|
+  spec.name          = "filename"
+  spec.version       = FileName::VERSION
+  spec.authors       = ["Takayuki YAMAGUCHI"]
+  spec.email         = ["d@ytak.info"]
+  spec.description   = "File name generator with sequential number or time string"
+  spec.summary       = "Create filename with sequential number or time string that is not duplicated."
+  spec.homepage      = ""
+  spec.license       = "GPLv3"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Takayuki YAMAGUCHI"]
-  s.date = %q{2011-04-15}
-  s.description = %q{Create filename with sequential number or time string that is not duplicated.}
-  s.email = %q{d@ytak.info}
-  s.executables = ["filename-create"]
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.md"
-  ]
-  s.files = [
-    ".document",
-    ".rspec",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "README.md",
-    "Rakefile",
-    "VERSION",
-    "bin/filename-create",
-    "filename.gemspec",
-    "lib/filename.rb",
-    "spec/cache_spec.rb",
-    "spec/configuration_spec.rb",
-    "spec/filename_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/ytaka/filename}
-  s.licenses = ["GPLv3"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.7.2}
-  s.summary = %q{Filename generator}
-  s.test_files = [
-    "spec/cache_spec.rb",
-    "spec/configuration_spec.rb",
-    "spec/filename_spec.rb",
-    "spec/spec_helper.rb"
-  ]
+  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"]
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 2.5.0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-    else
-      s.add_dependency(%q<rspec>, [">= 2.5.0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<rspec>, [">= 2.5.0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-  end
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "yard"
 end
-

data/lib/filename.rb

@@ -1,3 +1,4 @@
+require "filename/version"
 autoload :FileUtils, 'fileutils'
 
 # 
@@ -46,6 +47,9 @@ class FileName
   #  which is set by an option :format.
   #  If we set { :a => 1, :b => 2 } for :data option,
   #  we can use @a and @b in proc object set by :format option.
+  #
+  # [:filter]
+  #  We specify filters :before and after for basename without suffix, which is got by File.basename(path, ".*")
   # 
   # [:extension]
   #  Default value of the option of FileName#create.
@@ -65,7 +69,8 @@ class FileName
       opts = {}
     end
     path = File.join(basepath, *rest)
-    if opts[:path] == :relative
+    @relative_path_p = (opts[:path] == :relative)
+    if @relative_path_p
       @basepath = path
     else
       @basepath = File.expand_path(path)
@@ -93,23 +98,28 @@ class FileName
         @data.instance_variable_set("@#{key}", val)
       end
     end
+    @filter = opts[:filter] || {}
   end
 
-  def get_basepath(extension = nil)
+  def get_basepath(basepath, extension = nil)
     if extension
       extension = '.' + extension unless extension[0] == '.'
-      oldext = File.extname(@basepath)
+      oldext = File.extname(basepath)
       if oldext.size > 0
-        @basepath.sub(Regexp.new("\\#{oldext}$"), extension)
+        basepath.sub(Regexp.new("\\#{oldext}$"), extension)
       else
-        @basepath + extension
+        basepath + extension
       end
     else
-      @basepath
+      basepath
     end
   end
   private :get_basepath
 
+  def relative_path?
+    @relative_path_p
+  end
+
   def create_time_addition(t)
     case @format
     when String
@@ -218,9 +228,23 @@ class FileName
   end
   private :write_file
 
+  def filter_exec(filter, path)
+    dir, basename = File.split(path)
+    extname = File.extname(basename)
+    basename_new = filter.call(basename.sub(/#{extname}$/, "")) + extname
+    if relative_path? && dir == "."
+      basename_new
+    else
+      File.join(dir, basename_new)
+    end
+  end
+  private :filter_exec
+
   # The options are following:
   # [:extension (String of extension)]
   #  If we want to change extension, we set the value of the option.
+  #  Note that if we specify "txt" as :extension option, generated filesame is the format "SOME_STRING.txt";
+  #  that is, this method adds "." + (specified extension).
   # 
   # [:add (:always, :auto, or :prohibit)]
   #  We specify if the additional part is used.
@@ -238,7 +262,11 @@ class FileName
   #  If the value is :write and the file does not exist, we create an empty file.
   #  If the value is nil, we do nothing.
   def create(opts = {})
-    base = get_basepath(get_option_create(opts, :extension))
+    basepath = @basepath
+    if @filter[:before]
+      basepath = filter_exec(@filter[:before], basepath)
+    end
+    base = get_basepath(basepath, get_option_create(opts, :extension))
     opt_add = get_option_create(opts, :add)
     if addition = get_addition(opt_add, base)
       path = add_addition(base, addition)
@@ -253,6 +281,9 @@ class FileName
     else
       path = base
     end
+    if @filter[:after]
+      path = filter_exec(@filter[:after], path)
+    end
     create_directory(path, get_option_create(opts, :directory))
     write_file(path, get_option_create(opts, :file))
     path

data/lib/filename/version.rb

@@ -0,0 +1,3 @@
+class FileName
+  VERSION = "0.1.1"
+end

data/spec/filename_spec.rb

@@ -180,6 +180,23 @@ describe FileName do
     FileName.create('abc', 'def', 'ghi', :path => :relative, :add => :prohibit).should == 'abc/def/ghi'
   end
 
+  it "should execute before filter" do
+    FileName.create("name.txt", :filter => { :before => lambda { |basename| basename + "_before" } }, :add => :prohibit, :path => :relative).should == "name_before.txt"
+  end
+
+  it "should execute after filter" do
+    FileName.create("name.txt", :filter => { :after => lambda { |basename| basename + "_after" } }, :add => :prohibit, :path => :relative).should == "name_after.txt"
+  end
+
+  it "should execute before and after filters" do
+    FileName.create("name.txt",
+                    :filter => {
+                      :before => lambda { |basename| "before_" + basename },
+                      :after => lambda { |basename| basename + "_after" }
+                    },
+                    :add => :prohibit, :path => :relative).should == "before_name_after.txt"
+  end
+
   context "when we set the default options of FileName#create" do
     NUMBER_TEST_REPEAT = 3
     

metadata

@@ -1,118 +1,119 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: filename
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.1.1
 platform: ruby
-authors: 
+authors:
 - Takayuki YAMAGUCHI
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-04-15 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.5.0
-  type: :development
-  prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+date: 2013-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: 1.0.0
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: jeweler
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: 1.5.2
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rcov
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id004
-description: Create filename with sequential number or time string that is not duplicated.
-email: d@ytak.info
-executables: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: File name generator with sequential number or time string
+email:
+- d@ytak.info
+executables:
 - filename-create
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE.txt
-- README.md
-files: 
-- .document
-- .rspec
+extra_rdoc_files: []
+files:
+- .gitignore
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- VERSION
 - bin/filename-create
 - filename.gemspec
 - lib/filename.rb
+- lib/filename/version.rb
 - spec/cache_spec.rb
 - spec/configuration_spec.rb
 - spec/filename_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/ytaka/filename
-licenses: 
+homepage: ''
+licenses:
 - GPLv3
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: -1890861991035807209
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
-summary: Filename generator
-test_files: 
+specification_version: 4
+summary: Create filename with sequential number or time string that is not duplicated.
+test_files:
 - spec/cache_spec.rb
 - spec/configuration_spec.rb
 - spec/filename_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt

data/.rspec

@@ -1 +0,0 @@
---color

data/Gemfile.lock

@@ -1,28 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    diff-lcs (1.1.2)
-    git (1.2.5)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-    rake (0.8.7)
-    rcov (0.9.9)
-    rspec (2.5.0)
-      rspec-core (~> 2.5.0)
-      rspec-expectations (~> 2.5.0)
-      rspec-mocks (~> 2.5.0)
-    rspec-core (2.5.1)
-    rspec-expectations (2.5.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.5.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.5.2)
-  rcov
-  rspec (>= 2.5.0)

data/VERSION

@@ -1 +0,0 @@
-0.1.0