writer 0.3.0 → 0.3.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MDQ3ZTE5YWEwNzVlZTA4M2NmNzUyY2ExYzkwMWIyZWY4MTU5NDA0NQ==
+  data.tar.gz: !binary |-
+    NDdhNGJhZDYzNTZlZTY2YmNiNmM1MWM3NzcxMDlhMjRiYzU1NzkxYw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MDUyNTE4ZWM4YjliZTg4OWQxMWZkZWU4N2EwNzVlZThhNDU3NWFiOGM4YTg5
+    NDg5MWQ2ZWFkMjQwYTczOWMwYzgyYmU5MmI1OGY5OGI3NTRiZTFlNjFmOWZj
+    YjgwYTBhYmIyNDQ3YTA0ZDhjOWZiNGIyMmZmZTFhNGQ5ODRhMDc=
+  data.tar.gz: !binary |-
+    NzU4NWUyOGRjNTExYjM5MmZlMzc5NWVmM2UwNTA1M2IxNDg4YjBhNWZiMWVi
+    ODY3ZWNkNzAzZjM4NjA3NzEzNjZkYTI3NjQ3MWE5ZDJhMDllZTA1OGQzNWFk
+    MmZiYmZjYTcyMGNhZjY1YzgyNzdmNTQxNzYxYzI5NDEzODRmOTI=

data/Rakefile

@@ -1,2 +1,11 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+RSpec::Core::RakeTask.new(:nested_spec) do |t|
+  t.rspec_opts = "--format nested"
+end
+task :nested => :nested_spec

data/bin/wr

@@ -6,10 +6,10 @@ filename = ARGV[0]
 content = ARGV[1]
 
 if (load_config = File.open('config/writer.yml') rescue nil)
-  config = YAML.load(load_config)
+  writer_config = YAML.load(load_config)
 
-  Writer.configure do |c|
-    c.template_path = config['template_path']
+  Writer.configure do |config|
+    config.template_path = writer_config['template_path']
   end
 end
 

data/lib/writer/configuration.rb

@@ -1,5 +1,29 @@
+require "active_support/all"
+
 module Writer
   class Configuration
-    attr_accessor :template_path
+    attr_accessor :template_path, :date_format, :namer, :creator
+
+    def initialize
+      @namer   ||= 'Writer::FileNamer'
+      @creator ||= 'Writer::FileCreator'
+    end
+
+    def namer
+      const(@namer)
+    end
+
+    def creator
+      const(@creator)
+    end
+
+    private
+    def const(name)
+      if (parts = name.to_s.split('_')).size > 1
+        parts.collect(&:capitalize).join.constantize
+      else
+        name.constantize
+      end
+    end
   end
 end

data/lib/writer/file_creator.rb

@@ -3,12 +3,9 @@ require "writer/file_namer"
 module Writer
   class FileCreator
     class << self
-      def create!(filename, content)
-        name = FileNamer.name_for(filename)
-        content = content
-
-        create_file(name, content)
-        File.open(name, 'r')
+      def create!(filename, content = nil)
+        create_file(filename, content)
+        File.open(filename, 'r')
       end
 
       private

data/lib/writer/file_namer.rb

@@ -1,10 +1,15 @@
+require "date"
+
 module Writer
   class FileNamer
     class << self
       def name_for(filename)
-        name = fix_standard(filename)
+        filename ||= default_filename
+
+        name   = fix_standard(filename)
         name ||= fix_no_ext(filename)
         name ||= prevent_overwrite(filename)
+
         name
       end
 
@@ -39,6 +44,20 @@ module Writer
         name
       end
 
+      def default_filename
+        date = Date.today
+        date.strftime("#{date_format}.md")
+      end
+
+      def separator_for(name, base = nil)
+        return "." if base || name.include?('.')
+        "--"
+      end
+
+      def config
+        @configuration ||= Writer.config
+      end
+
       private
       def append_count(name, separator, count)
         basename = name.gsub(/(--|\.)\d*$/, '')
@@ -47,12 +66,8 @@ module Writer
         [basename, separator, zero_pad, count].join
       end
 
-      def separator_for(name, base = nil)
-        if base || name.include?('.')
-          "."
-        else
-          "--"
-        end
+      def date_format
+        config.date_format || '%Y-%m%b-%d'
       end
     end
   end

data/lib/writer/version.rb

@@ -1,3 +1,3 @@
 module Writer
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/lib/writer.rb

@@ -1,13 +1,11 @@
-require "date"
 require "writer/configuration"
 require "writer/version"
-require "writer/file_creator"
 
 module Writer
   class << self
     def write!(name = nil, content = nil)
-      name ||= default_filename
-      FileCreator.create!(name, content)
+      name = namer.name_for(name)
+      creator.create!(name, content)
     end
 
     def configure
@@ -16,15 +14,11 @@ module Writer
 
     # attempt delegation to config
     def method_missing(name, *args)
-      return config.send(name, *args)
-      rescue
-        super
+      config.send(name, *args)
     end
 
-    private
-    def default_filename
-      date = Date.today
-      date.strftime('%Y-%m%b-%d.md')
+    def config=(other)
+      @config = other
     end
 
     def config
@@ -33,6 +27,8 @@ module Writer
   end
 end
 
+require "writer/file_creator"
+
 def wr(*args)
   `wr #{args.join(' ')}`
 end

data/spec/config_spec.rb

@@ -0,0 +1,47 @@
+require "writer"
+class MyCreator; end
+class MyNamer; end
+
+module Writer
+  describe Configuration do
+    after :all do
+      Writer.config = Configuration.new
+    end
+
+    it "defaults template_path to nil" do
+      Writer.template_path.should be_nil
+    end
+
+    it "takes a template_path" do
+      Writer.configure do |c|
+        c.template_path = 'hi'
+      end
+
+      Writer.template_path.should == 'hi'
+    end
+
+    it "defaults creator to FileCreator" do
+      Writer.creator.should == FileCreator
+    end
+
+    it "takes a creator" do
+      Writer.configure do |c|
+        c.creator = :my_creator
+      end
+
+      Writer.creator.should == MyCreator
+    end
+
+    it "defaults namer to FileNamer" do
+      Writer.namer.should == FileNamer
+    end
+
+    it "takes a namer" do
+      Writer.configure do |c|
+        c.namer = :my_namer
+      end
+
+      Writer.namer.should == MyNamer
+    end
+  end
+end

data/spec/creator_spec.rb

@@ -0,0 +1,40 @@
+require "writer/file_creator"
+
+module Writer
+  describe FileCreator do
+    let(:file) { stub(:file) }
+
+    before :each do
+      File.stub(:open)
+          .with('filename', 'w')
+          .and_yield(file)
+
+      File.stub(:open)
+          .with('filename', 'r')
+          .and_return(true)
+    end
+
+    context "with content" do
+      it "writes the content" do
+        file.should_receive(:puts).with('hi')
+        FileCreator.create!('filename', 'hi')
+      end
+    end
+
+    context "without content" do
+      it "leaves a blank line" do
+        FileCreator.stub(:template) { nil }
+        file.should_receive(:puts).with(nil)
+        FileCreator.create!('filename')
+      end
+
+      it "uses a template, if it exists" do
+        template = stub(:read => "hello\nworld")
+        FileCreator.stub(:template) { template.read }
+
+        file.should_receive(:puts).with("hello\nworld")
+        FileCreator.create!('filename')
+      end
+    end
+  end
+end

data/spec/namer_spec.rb

@@ -0,0 +1,61 @@
+require "writer"
+
+module Writer
+  describe FileNamer do
+    before :each do
+      File.stub(:exists?)
+          .with(/^\D+[^(\-\-)\d]$/)
+          .and_return(true)
+
+      File.stub(:exists?)
+          .with(/^\S*\d+.*$/)
+          .and_return(false)
+    end
+
+    it "defaults to today's date" do
+      Date.stub(:today) do
+        Date.new(2012, 1, 3)
+      end
+      name = FileNamer.name_for(nil)
+      name.should == "2012-01Jan-03.md"
+    end
+
+    it "uses a configured date format" do
+      Writer.configure do |config|
+        config.date_format = '%e-%m%b-%Y'
+      end
+
+      Date.stub(:today) do
+        Date.new(2013, 8, 12)
+      end
+
+      name = FileNamer.name_for(nil)
+      name.should == "12-08Aug-2013.md"
+    end
+
+    it "prevents overwriting" do
+      name = FileNamer.name_for('hi')
+      name.should == 'hi--02'
+    end
+
+    it "plays well with standard filenames" do
+      name = FileNamer.name_for('std.rb')
+      name.should == 'std.02.rb'
+    end
+
+    it "plays well with a dot at the end" do
+      name = FileNamer.name_for('dot.')
+      name.should == 'dot.02.'
+    end
+
+    it "plays well with a dot at the beginning" do
+      name = FileNamer.name_for('.dot')
+      name.should == '.dot.02'
+    end
+
+    it "plays well with multiple dots" do
+      name = FileNamer.name_for('some.jquery.file')
+      name.should == 'some.jquery.02.file'
+    end
+  end
+end

data/spec/writer_spec.rb

@@ -1,14 +1,8 @@
 require 'writer'
 
 describe Writer do
-  before :each do
-    Date.stub(:today) do
-      Date.new(2012, 1, 3)
-    end
-  end
-
   after :all do
-    cleanup_files
+    delete_files
   end
 
   it "creates today's file, blank" do
@@ -21,77 +15,16 @@ describe Writer do
     file.read.should == "\n"
   end
 
-  it "prevents overwriting" do
-    50.times do
-      Writer.write!
-    end
-
-    File.open('2012-01Jan-03.02.md')
-    File.open('2012-01Jan-03.52.md')
-  end
-
-  it "plays well with no dots" do
-    file = Writer.write!('nodots')
-    File.basename(file).should == 'nodots'
-
-    file = Writer.write!('nodots')
-    File.basename(file).should == 'nodots--02'
-  end
-
-  it "plays well with a dot at the end" do
-    file = Writer.write!('dot.')
-    File.basename(file).should == 'dot.'
-
-    file = Writer.write!('dot.')
-    File.basename(file).should == 'dot.02.'
-  end
-
-  it "plays well with a dot at the beginning" do
-    file = Writer.write!('.dot')
-    File.basename(file).should == '.dot'
-
-    file = Writer.write!('.dot')
-    File.basename(file).should == '.dot.02'
-  end
-
-  it "plays well with multiple dots" do
-    Writer.write!('some.jquery.file')
-    file = Writer.write!('some.jquery.file')
-    File.basename(file).should == 'some.jquery.02.file'
-  end
-
-  it "creates the file with your custom name" do
+  it "uses your custom name" do
     filename = "My custom filename.txt"
-    Writer.write!(filename)
-    File.open(filename)
-  end
-
-  it "uses a template, if it exists" do
-    body = "hello\nworld"
-    Writer.write!('.template', body)
-
-    Writer.configure do |c|
-      c.template_path = '.template'
-    end
 
-    file = Writer.write!
-    file.read.should == body + "\n"
+    Writer.write!(filename)
+    File.delete(filename)
   end
 end
 
-def cleanup_files
-  File.delete('2012-01Jan-03.md')
-  52.times do |n|
-    File.delete("2012-01Jan-03.#{'0' if n < 8}#{n + 2}.md")
+def delete_files
+  Dir.glob("20*.md") do |filename|
+    File.delete(filename)
   end
-  File.delete('nodots')
-  File.delete('dot.')
-  File.delete('dot.02.')
-  File.delete('some.jquery.file')
-  File.delete('some.jquery.02.file')
-  File.delete('.template')
-  File.delete('My custom filename.txt')
-  File.delete('.dot')
-  File.delete('.dot.02')
-  File.delete('nodots--2')
 end

data/writer.gemspec

@@ -15,5 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths       = ["lib"]
   gem.version             = Writer::VERSION
 
+  gem.add_dependency 'activesupport'
+
   gem.add_development_dependency 'rspec'
 end

metadata

@@ -1,27 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: writer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
-  prerelease: 
+  version: 0.3.1
 platform: ruby
 authors:
 - Joe Sak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-15 00:00:00.000000000 Z
+date: 2013-08-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70124302849860 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70124302849860
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Easily start a new file to write in.
 email:
 - joe@joesak.com
@@ -44,32 +60,37 @@ files:
 - lib/writer/file_namer.rb
 - lib/writer/version.rb
 - spec/.gitkeep
+- spec/config_spec.rb
+- spec/creator_spec.rb
+- spec/namer_spec.rb
 - spec/writer_spec.rb
 - writer.gemspec
 homepage: ''
 licenses: []
+metadata: {}
 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: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 2.0.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Start a new file and write in it.
 test_files:
 - spec/.gitkeep
+- spec/config_spec.rb
+- spec/creator_spec.rb
+- spec/namer_spec.rb
 - spec/writer_spec.rb