writer 0.0.3 → 0.0.4

data/README.md

@@ -1,10 +1,15 @@
 # Writer
 
-TODO: Write a gem description
+This gem adds a command line utility that writes a new file for you.
+
+## Doesn't touch do that?
+
+Yes, but with this gem you can simply type `wr` and it defaults to
+a markdown file named after today's date.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Create a bundler Gemfile and add this:
 
     gem 'writer'
 
@@ -18,10 +23,36 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```
+$ wr
+#=> Creates a MarkDown file named after today's date
+## e.g. `2012-01Jan-03.md`
+
+$ wr hello
+#=> Creates a file named `hello`
+
+$ wr hello world
+#=> Creates a file named `hello` with the content `world`
+```
+
+## Use a template
+
+The Writer will copy a template file's contents into your new file
+if you configure the template file's path.
+
+Add `config/writer.yml` to the root directory of your project or journal
+
+Create a file named whatever you want, the example uses `.template`
+in the project root
+
+```yml
+template_path: .template
+```
 
 ## Contributing
 
+Please provide a spec covering your feature or bug fix, thank you!
+
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)

data/lib/writer/file_creator.rb

@@ -0,0 +1,34 @@
+require "writer/overwrite_prevention"
+
+module Writer
+  class FileCreator
+    class << self
+      attr_accessor :name, :content
+
+      def create!(name, content)
+        @name = OverwritePrevention.adjust(name)
+        @content = content
+
+        create_file
+        return file
+      end
+
+      private
+      def create_file
+        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
+      end
+
+      def file
+        File.open(name, 'r')
+      end
+    end
+  end
+end

data/lib/writer/overwrite_prevention.rb

@@ -0,0 +1,25 @@
+module Writer
+  class OverwritePrevention
+    def self.adjust(name)
+      count = 1
+
+      while File.exists?(name)
+        name = append_count(name, count +=1)
+      end
+
+      name
+    end
+
+    def self.append_count(name, count)
+      if (split = name.split('.')).length > 1
+        ext = split.last
+        split.delete(ext)
+        name = split.join('.')
+      end
+
+      name = name.gsub(/--\d$/,'')
+
+      [name + "--#{count}", '.', ext].join
+    end
+  end
+end

data/lib/writer/version.rb

@@ -1,3 +1,3 @@
 module Writer
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/writer.rb

@@ -1,65 +1,34 @@
 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 if name.nil?
-      protect_from_overwrite(name)
-      create_file(content)
-      File.open(filename, 'r')
+      name ||= default_filename
+      FileCreator.create!(name, content)
     end
 
     def configure
-      @config = Configuration.new
-      yield(@config)
+      yield(config)
     end
 
-    private
-    def protect_from_overwrite(name)
-      count = 1
-      while File.exists?(name)
-        name = append_count(name, count += 1)
-      end
-      @filename = name
-    end
-
-    def create_file(content = nil)
-      File.open(filename, 'w') do |f|
-        f.puts content || template
-      end
-    end
-
-    def append_count(name, count)
-      if (split = name.split('.')).length > 1
-        ext = split.last
-        split.delete(ext)
-        name = split.join
-      end
-
-      name = name.gsub(/--\d$/,'')
-
-      [name + "--#{count}", '.', ext].join
+    # attempt delegation to config
+    def method_missing(name, *args)
+      return config.send(name, *args)
+      rescue
+        super
     end
 
+    private
     def default_filename
       date = Date.today
       date.strftime('%Y-%m%b-%d.md')
     end
 
-    def template
-      if config.template_path
-        File.open(config.template_path).read
-      end
-    end
-
     def config
       @config ||= Configuration.new
     end
-
-    def filename
-      @filename
-    end
   end
 end

data/spec/writer_spec.rb

@@ -29,6 +29,12 @@ describe Writer do
     File.open('2012-01Jan-03--3.md')
   end
 
+  it "preserves periods" do
+    Writer.write!('some.jquery.file')
+    file = Writer.write!('some.jquery.file')
+    File.basename(file).should == 'some.jquery--2.file'
+  end
+
   it "creates the file with your custom name" do
     filename = "My custom filename.txt"
     Writer.write!(filename)
@@ -54,6 +60,8 @@ def cleanup_files
   File.delete('2012-01Jan-03--3.md')
   File.delete('2012-01Jan-03--4.md')
   File.delete('2012-01Jan-03--5.md')
+  File.delete('some.jquery.file')
+  File.delete('some.jquery--2.file')
   File.delete('.template')
   File.delete('My custom filename.txt')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: writer
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-14 00:00:00.000000000 Z
+date: 2012-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70224064989180 !ruby/object:Gem::Requirement
+  requirement: &70185578605260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70224064989180
+  version_requirements: *70185578605260
 description: Easily start a new file to write in.
 email:
 - joe@joesak.com
@@ -40,6 +40,8 @@ files:
 - bin/wr
 - lib/writer.rb
 - lib/writer/configuration.rb
+- lib/writer/file_creator.rb
+- lib/writer/overwrite_prevention.rb
 - lib/writer/version.rb
 - spec/.gitkeep
 - spec/writer_spec.rb