writer 0.3.1 → 0.4.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!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=
+SHA1:
+  metadata.gz: ad036d03f4aebf06450cd8089c28c88a9084ca3b
+  data.tar.gz: 7fd70f5d6f4a2bbdd7bab8eacf471fcf28721985
+SHA512:
+  metadata.gz: eb590424088d7a46cce133dcbfe8973a24872565c1d20a49807281bf7628bbb864c0a37e5a71241ea7d2d95c2fc2bb56aa818c36f22e64c05e2ff59920914430
+  data.tar.gz: 91954bd16c4055b43fe69868c121eadeda5977f652f8371c4c55a2ecdb338033a7877a5d00789bc93e41135119b798af0292737ac58ae315d4cda835e53e0e66

data/.ruby-gemset

@@ -0,0 +1 @@
+writer

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0

data/README.md

@@ -61,6 +61,20 @@ in the project root
 template_path: .template
 ```
 
+## Configuration
+
+```yml
+# in config/writer.yml
+
+# default config:
+namer:         'Writer::FileNamer'
+creator:       'Writer::FileCreator'
+logger:        'Writer::Logger'
+date_format:   '%Y-%m%b-%d'
+log_level:     2 # 0 - err, 1 - warn, 2 - info, 3 - debug
+template_path: ''
+```
+
 ## Contributing
 
 Please provide a spec covering your feature or bug fix, thank you!

data/bin/wr

@@ -5,12 +5,4 @@ require 'writer'
 filename = ARGV[0]
 content = ARGV[1]
 
-if (load_config = File.open('config/writer.yml') rescue nil)
-  writer_config = YAML.load(load_config)
-
-  Writer.configure do |config|
-    config.template_path = writer_config['template_path']
-  end
-end
-
 Writer.write!(filename, content)

data/config/writer.yml

@@ -0,0 +1 @@
+log_level: 1

data/lib/writer/configuration.rb

@@ -2,28 +2,55 @@ require "active_support/all"
 
 module Writer
   class Configuration
-    attr_accessor :template_path, :date_format, :namer, :creator
+    attr_accessor :template_path, :date_format, :attributes,
+      :log_level, :logger, :namer, :creator
 
-    def initialize
-      @namer   ||= 'Writer::FileNamer'
-      @creator ||= 'Writer::FileCreator'
+    def initialize(attrs = {})
+      attrs = attrs.merge(config)
+
+      attrs.each do |attr, value|
+        self.send("#{attr}=", value)
+      end
+
+      @attributes = attrs
+    end
+
+    def namer=(other)
+      @namer = Object.const_get(other)
     end
 
-    def namer
-      const(@namer)
+    def logger=(other)
+      @logger = Object.const_get(other)
     end
 
-    def creator
-      const(@creator)
+    def creator=(other)
+      @creator = Object.const_get(other)
     end
 
     private
-    def const(name)
-      if (parts = name.to_s.split('_')).size > 1
-        parts.collect(&:capitalize).join.constantize
-      else
-        name.constantize
+    def config
+      conf = default_config
+      path = 'config/writer.yml'
+
+      if File.exist?(path)
+        config_file = File.open(path)
+        user_config = YAML.load(config_file)
+
+        conf = conf.merge(user_config)
       end
+
+      conf
+    end
+
+    def default_config
+      {
+        namer:         'Writer::FileNamer',
+        creator:       'Writer::FileCreator',
+        logger:        'Writer::Logger',
+        date_format:   '%Y-%m%b-%d',
+        log_level:     2, # see Logger for levels
+        template_path: ''
+      }
     end
   end
 end

data/lib/writer/file_creator.rb

@@ -1,24 +1,20 @@
-require "writer/file_namer"
-
 module Writer
   class FileCreator
-    class << self
-      def create!(filename, content = nil)
-        create_file(filename, content)
-        File.open(filename, 'r')
-      end
+    def create!(filename, content = nil)
+      create_file(filename, content)
+      File.open(filename, 'r')
+    end
 
-      private
-      def create_file(name, content)
-        File.open(name, 'w') do |f|
-          f.puts content || template
-        end
+    private
+    def create_file(name, content)
+      File.open(name, 'w') do |f|
+        f.puts content || template
       end
+    end
 
-      def template
-        if Writer.template_path
-          File.open(Writer.template_path).read
-        end
+    def template
+      unless Writer.template_path.blank?
+        File.open(Writer.template_path).read
       end
     end
   end

data/lib/writer/file_namer.rb

@@ -2,73 +2,73 @@ require "date"
 
 module Writer
   class FileNamer
-    class << self
-      def name_for(filename)
-        filename ||= default_filename
+    attr_reader :config
 
-        name   = fix_standard(filename)
-        name ||= fix_no_ext(filename)
-        name ||= prevent_overwrite(filename)
+    def initialize
+      @config = Writer.config
+    end
 
-        name
-      end
+    def name_for(filename)
+      filename ||= default_filename
 
-      def fix_standard(name)
-        if /.+\..+/ =~ name
-          parts = name.split('.')
-          basename = parts[0..-2].join('.')
-          extension = parts.last
+      name   = fix_standard(filename)
+      name ||= fix_no_ext(filename)
+      name ||= prevent_overwrite(filename)
 
-          prevent_overwrite(name, basename, extension)
-        end
-      end
+      name
+    end
 
-      def fix_no_ext(name)
-        if /\.$/ =~ name
-          basename = name.gsub('.', '')
+    def fix_standard(name)
+      if /.+\..+/ =~ name
+        parts = name.split('.')
+        basename = parts[0..-2].join('.')
+        extension = parts.last
 
-          prevent_overwrite(name, basename)
-        end
+        prevent_overwrite(name, basename, extension)
       end
+    end
 
-      def prevent_overwrite(name, base = nil, ext = nil)
-        separator = separator_for(name, base)
-        to_fix = base || name
-        count = 1
-
-        while File.exists?(name)
-          name = append_count(to_fix, separator, count += 1)
-          name << ".#{ext}" if base
-        end
+    def fix_no_ext(name)
+      if /\.$/ =~ name
+        basename = name.gsub('.', '')
 
-        name
+        prevent_overwrite(name, basename)
       end
+    end
 
-      def default_filename
-        date = Date.today
-        date.strftime("#{date_format}.md")
-      end
+    def prevent_overwrite(name, base = nil, ext = nil)
+      separator = separator_for(name, base)
+      to_fix = base || name
+      count = 1
 
-      def separator_for(name, base = nil)
-        return "." if base || name.include?('.')
-        "--"
+      while File.exists?(name)
+        name = append_count(to_fix, separator, count += 1)
+        name << ".#{ext}" if base
       end
 
-      def config
-        @configuration ||= Writer.config
-      end
+      name
+    end
 
-      private
-      def append_count(name, separator, count)
-        basename = name.gsub(/(--|\.)\d*$/, '')
-        zero_pad = count < 10 ? 0 : nil
+    def default_filename
+      date = Date.today
+      date.strftime("#{date_format}.md")
+    end
 
-        [basename, separator, zero_pad, count].join
-      end
+    def separator_for(name, base = nil)
+      return "." if base || name.include?('.')
+      "--"
+    end
 
-      def date_format
-        config.date_format || '%Y-%m%b-%d'
-      end
+    private
+    def append_count(name, separator, count)
+      basename = name.gsub(/(--|\.)\d*$/, '')
+      zero_pad = count < 10 ? 0 : nil
+
+      [basename, separator, zero_pad, count].join
+    end
+
+    def date_format
+      config.date_format
     end
   end
 end

data/lib/writer/logger.rb

@@ -0,0 +1,33 @@
+module Writer
+  class Logger
+    def info(*args)
+      return if log_level < 2
+
+      out = if args.many?
+              o = ["#{args.pop}:"]
+              args.each { |a| o << a }
+            else
+              [args]
+            end
+
+      $stdout.print(out.join(' ') + "\n")
+    end
+
+    class << self
+      def config
+        @config ||= Writer.config
+      end
+    end
+
+    private
+    #log_level
+    #
+    # 0 - error
+    # 1 - warn
+    # 2 - info
+    # 3 - debug
+    def log_level
+      self.class.config.log_level
+    end
+  end
+end

data/lib/writer/version.rb

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

data/lib/writer.rb

@@ -1,34 +1,52 @@
-require "writer/configuration"
-require "writer/version"
-
 module Writer
+  autoload :Version,       "writer/version"
+  autoload :FileNamer,     "writer/file_namer"
+  autoload :FileCreator,   "writer/file_creator"
+  autoload :Logger,        "writer/logger"
+  autoload :Configuration, "writer/configuration"
+
   class << self
     def write!(name = nil, content = nil)
-      name = namer.name_for(name)
-      creator.create!(name, content)
+      name = file_namer.name_for(name)
+
+      logger.info "Creating #{name}"
+
+      file_creator.create!(name, content)
     end
 
-    def configure
-      yield(config)
+    def file_namer
+      @file_namer ||= namer.new
+    end
+
+    def file_creator
+      @file_creator ||= creator.new
     end
 
-    # attempt delegation to config
-    def method_missing(name, *args)
-      config.send(name, *args)
+    def logger
+      @logger ||= config.logger.new
     end
 
-    def config=(other)
-      @config = other
+    def configure
+      yield(config)
     end
 
     def config
       @config ||= Configuration.new
     end
+
+    def set_default_config!
+      @config = Configuration.new
+    end
+
+    def method_missing(method_name, *args)
+      attrs = config.attributes.keys
+      return super unless attrs.include?(method_name)
+
+      config.send(method_name, *args)
+    end
   end
 end
 
-require "writer/file_creator"
-
 def wr(*args)
   `wr #{args.join(' ')}`
 end

data/spec/config_spec.rb

@@ -1,15 +1,20 @@
 require "writer"
-class MyCreator; end
-class MyNamer; end
+module Creators; class MyCreator; end; end
+module Namers; class MyNamer; end; end;
 
 module Writer
   describe Configuration do
     after :all do
-      Writer.config = Configuration.new
+      Writer.set_default_config!
     end
 
-    it "defaults template_path to nil" do
-      Writer.template_path.should be_nil
+    it "defaults template_path blank" do
+      Writer.template_path.should be_blank
+    end
+
+    it "defaults date_format to american" do
+      # and in a format that helps with file sorting
+      Writer.date_format.should == '%Y-%m%b-%d'
     end
 
     it "takes a template_path" do
@@ -20,16 +25,24 @@ module Writer
       Writer.template_path.should == 'hi'
     end
 
+    it "takes a date_format" do
+      Writer.configure do |c|
+        c.date_format = 'hello there'
+      end
+
+      Writer.date_format.should == 'hello there'
+    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
+        c.creator = 'Creators::MyCreator'
       end
 
-      Writer.creator.should == MyCreator
+      Writer.creator.should == Creators::MyCreator
     end
 
     it "defaults namer to FileNamer" do
@@ -38,10 +51,10 @@ module Writer
 
     it "takes a namer" do
       Writer.configure do |c|
-        c.namer = :my_namer
+        c.namer = 'Namers::MyNamer'
       end
 
-      Writer.namer.should == MyNamer
+      Writer.namer.should == Namers::MyNamer
     end
   end
 end

data/spec/creator_spec.rb

@@ -2,7 +2,8 @@ require "writer/file_creator"
 
 module Writer
   describe FileCreator do
-    let(:file) { stub(:file) }
+    let(:file)    { stub(:file) }
+    let(:creator) { FileCreator.new }
 
     before :each do
       File.stub(:open)
@@ -17,23 +18,23 @@ module Writer
     context "with content" do
       it "writes the content" do
         file.should_receive(:puts).with('hi')
-        FileCreator.create!('filename', 'hi')
+        creator.create!('filename', 'hi')
       end
     end
 
     context "without content" do
       it "leaves a blank line" do
-        FileCreator.stub(:template) { nil }
+        creator.stub(:template) { nil }
         file.should_receive(:puts).with(nil)
-        FileCreator.create!('filename')
+        creator.create!('filename')
       end
 
       it "uses a template, if it exists" do
         template = stub(:read => "hello\nworld")
-        FileCreator.stub(:template) { template.read }
+        creator.stub(:template) { template.read }
 
         file.should_receive(:puts).with("hello\nworld")
-        FileCreator.create!('filename')
+        creator.create!('filename')
       end
     end
   end

data/spec/namer_spec.rb

@@ -2,6 +2,8 @@ require "writer"
 
 module Writer
   describe FileNamer do
+    let(:file_namer) { FileNamer.new }
+
     before :each do
       File.stub(:exists?)
           .with(/^\D+[^(\-\-)\d]$/)
@@ -16,7 +18,7 @@ module Writer
       Date.stub(:today) do
         Date.new(2012, 1, 3)
       end
-      name = FileNamer.name_for(nil)
+      name = file_namer.name_for(nil)
       name.should == "2012-01Jan-03.md"
     end
 
@@ -29,32 +31,32 @@ module Writer
         Date.new(2013, 8, 12)
       end
 
-      name = FileNamer.name_for(nil)
+      name = file_namer.name_for(nil)
       name.should == "12-08Aug-2013.md"
     end
 
     it "prevents overwriting" do
-      name = FileNamer.name_for('hi')
+      name = file_namer.name_for('hi')
       name.should == 'hi--02'
     end
 
     it "plays well with standard filenames" do
-      name = FileNamer.name_for('std.rb')
+      name = file_namer.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 = file_namer.name_for('dot.')
       name.should == 'dot.02.'
     end
 
     it "plays well with a dot at the beginning" do
-      name = FileNamer.name_for('.dot')
+      name = file_namer.name_for('.dot')
       name.should == '.dot.02'
     end
 
     it "plays well with multiple dots" do
-      name = FileNamer.name_for('some.jquery.file')
+      name = file_namer.name_for('some.jquery.file')
       name.should == 'some.jquery.02.file'
     end
   end

data/spec/writer_spec.rb

@@ -24,7 +24,7 @@ describe Writer do
 end
 
 def delete_files
-  Dir.glob("20*.md") do |filename|
+  Dir.glob("[^README]*.md") do |filename|
     File.delete(filename)
   end
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: writer
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Joe Sak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-13 00:00:00.000000000 Z
+date: 2013-08-15 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: !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'
 description: Easily start a new file to write in.
@@ -48,16 +48,19 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
-- .rvmrc
+- .ruby-gemset
+- .ruby-version
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - bin/wr
+- config/writer.yml
 - lib/writer.rb
 - lib/writer/configuration.rb
 - lib/writer/file_creator.rb
 - lib/writer/file_namer.rb
+- lib/writer/logger.rb
 - lib/writer/version.rb
 - spec/.gitkeep
 - spec/config_spec.rb
@@ -74,17 +77,17 @@ require_paths:
 - lib
 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: 2.0.5
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Start a new file and write in it.

data/.rvmrc

@@ -1 +0,0 @@
-rvm use --create 1.9.3@writer