processr 0.5.0 → 0.9.0

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.9.0

data/examples/all.rb

@@ -1,22 +1,31 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'processr'))
+require 'rubygems'
+require 'processr'
+
+# Setup
 
 Processr.configure do |config|
   config.root = File.expand_path(File.dirname(__FILE__))
-  config.out  = File.join(config.root, 'output.txt')
+  config.out  = nil
 end
 
 
-
-# Simple text concatenation.
+puts "Simple text concatenation:"
 
 processor = Processr.new
-processor << 'one.txt'
-processor << 'two.txt'
-processor.process!
+processor << "Some Text\n"
+processor << "Some More Text"
+puts processor.process!
+
 
+puts "Simple text concatenation form files:"
+
+processor = Processr.new
+processor.files << File.join('..', 'spec', 'fixtures', 'one.txt')
+processor.files << File.join('..', 'spec', 'fixtures', 'two.txt')
+puts processor.process!
 
 
-# Simple textile filter.
+puts "Simple textile filter using input:"
 
 TextileFilter = lambda do |buffer|
   
@@ -35,7 +44,5 @@ end
 
 processor = Processr.new
 processor.add_filter(TextileFilter)
-processor << 'text.textile'
-processor.process!
-
-puts "* Look in output.txt to see the result of this example."
+processor << 'A _simple_ example of a "textile":http://www.textism.com/tools/textile/ parser using a *filter*.'
+puts processor.process!

data/lib/processr.rb

@@ -1,6 +1,7 @@
 $:.unshift File.dirname(__FILE__)
 
 class Processr
+  
   class << self
     def root=(path); @root = path; end
     def root; @root; end
@@ -13,10 +14,11 @@ class Processr
     end
   end
   
-  attr_accessor :buffer, :filters
+  attr_accessor :buffer, :files, :filters
   
   def initialize
     self.buffer  = ""
+    self.files   = []
     self.filters = []
   end
   
@@ -25,23 +27,41 @@ class Processr
   end
   
   def process!
+    read_files
+    process_filters
+    write_output
+  end
+  
+  def <<(text)
+    self.buffer << text
+  end
+  
+  private
+  def read_files
+    self.files.each do |file|
+      read_file_to_buffer(file)
+    end
+  end
+  
+  def read_file_to_buffer(file)
+    self.buffer << File.open(File.join(self.class.root, file)).read
+  end
+  
+  def process_filters
     self.filters.each do |filter|
       self.buffer = filter.call(self.buffer)
     end
-    
-    write_buffer!
-    
-    true
   end
   
-  def <<(file)
-    self.buffer << File.open(File.join(self.class.root, file)).read
+  def write_output
+    self.class.out.nil? ? self.buffer : write_buffer_file
   end
   
-  private
-  def write_buffer!
+  def write_buffer_file
     output_file = File.open(self.class.out, "w+")
     output_file.puts self.buffer
     output_file.close
+    
+    true
   end
 end

data/processr.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{processr}
-  s.version = "0.5.0"
+  s.version = "0.9.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Josh Nesbitt"]
@@ -23,15 +23,12 @@ Gem::Specification.new do |s|
      "TODO",
      "VERSION",
      "examples/all.rb",
-     "examples/one.txt",
-     "examples/output.txt",
-     "examples/text.textile",
-     "examples/two.txt",
      "lib/processr.rb",
      "processr.gemspec",
      "readme.rdoc",
-     "spec/fixtures/one.js",
-     "spec/fixtures/two.js",
+     "spec/fixtures/one.txt",
+     "spec/fixtures/output.txt",
+     "spec/fixtures/two.txt",
      "spec/lib/processr_spec.rb",
      "spec/spec_helper.rb",
      "spec/watch.rb"

data/readme.rdoc

@@ -9,7 +9,9 @@
 
 == Overview
 
-Processr is a simple text processing and concatenation library. It takes a number of input files and outputs a single file with the result. Text can be passed through filters to modify the output.
+Processr is a simple text processing and concatenation library. It takes a number of input strings (or files) and outputs a single string (or file) containing the result. Text can be passed through filters to modify the output.
+
+
 
 == Installation
 
@@ -17,8 +19,11 @@ The project is hosted on rubygems.org. Getting it is simple:
 
   gem install processr
 
+
+
 == Usage
 
+
 === Configuration
 
 Use the configuration block to setup Processr
@@ -28,21 +33,37 @@ Use the configuration block to setup Processr
     config.out  = File.join(config.root, 'output.txt')
   end
 
+If an output file is specified the result will be written to that file, otherwise the result will be returned directly from the #process! method.
+
+
 === Basic
 
   processor = Processr.new
-  processor << 'input_one.txt'
-  processor << 'input_two.txt'
-  processor.process!
+  processor << "Some\n"
+  processor << "Text"
+  processor.process! # => "Some\nText"
+
+This will result in a concatenated string being returned.
 
-This will result in a single file being output with the contents of all files inputted.
 
-=== filters
+=== Basic (from file)
+
+  processor = Processr.new
+  processor.files << 'input_one.txt'
+  processor.files << 'input_two.txt'
+  processor.process! # => contents of input_one.txt and input_two.txt
+
+This will result in the contents of input_one.txt and input_two.txt returned.
+
+
+=== Filters
 
 Filters can be used to modify the output of a processing session. A filter is any object that responds to #call. Filters take a single argument (the input buffer) and must return the modified buffer for further processing. For example:
 
   lambda do |buffer|
     # ...do something with buffer here...
+    
+    buffer
   end
 
 Or
@@ -51,6 +72,8 @@ Or
     
     def self.call(buffer)
       # ...do something with buffer here...
+      
+      buffer
     end
     
   end
@@ -74,8 +97,8 @@ You can register a filter by calling #add_filter on an instance of Processr. A f
   
   processor = Processr.new
   processor.add_filter(TextileFilter)
-  processor << 'text.textile'
-  processor.process!
+  processor << 'A _simple_ example of a "textile":http://www.textism.com/tools/textile/ parser using a *filter*.'
+  processor.process! # => "A <em>simple</em> example of a <a href="http://www.textism.com/tools/textile/">textile</a> parser using a <strong>filter</strong>."
 
 Run the examples for more information.
 

data/spec/lib/processr_spec.rb

@@ -1,10 +1,11 @@
 describe Processr do
   
-  before :all do
+  before :each do
     Processr.configure do |config|
       config.root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-      config.out  = File.join(config.root, 'examples', 'all')
     end
+    
+    @processor = Processr.new
   end
   
   it "should successfully accept a configuration block" do
@@ -20,7 +21,7 @@ describe Processr do
     Processr.out.should be_nil
     
     root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-    out  = File.join(root, 'examples', 'all')
+    out  = File.join(root, '..', 'examples', 'all')
     
     Processr.configure do |config|
       config.root = root
@@ -31,4 +32,50 @@ describe Processr do
     Processr.out.should  == out
   end
   
+  it "should allow text to be added to the buffer" do
+    @processor.buffer.should == ""
+    @processor << "Some Text"
+    @processor.buffer.should == "Some Text"
+  end
+  
+  it "should read files to the buffer if no output file is provided" do
+    Processr.out = nil
+    @processor.buffer.should == ""
+    @processor.files << File.join('fixtures', 'one.txt')
+    @processor.files << File.join('fixtures', 'two.txt')
+    @processor.process!.should == "one\ntwo\n"
+  end
+  
+  it "should write files from the buffer if an output file is given" do
+    Processr.out = File.join(Processr.root, 'fixtures', 'output.txt')
+    
+    @processor.buffer.should == ""
+    @processor.files << File.join('fixtures', 'one.txt')
+    @processor.process!.should be_true
+    
+    File.exists?(File.join(Processr.root, 'fixtures', 'output.txt')).should == true
+    File.open(File.join(Processr.root, 'fixtures', 'output.txt')).read.should == "one\n"
+  end
+  
+  it "should allow the use of filters to modify output" do
+    Processr.out = nil
+    
+    LanguageFilter = lambda do |buffer|
+      lookup = [
+        "fucking",
+        "hate"
+      ]
+      
+      lookup.each do |word|
+        buffer.gsub!(word, ("*" * word.size))
+      end
+      
+      buffer
+    end
+    
+    @processor.add_filter(LanguageFilter)
+    @processor << "I fucking hate bad language."
+    @processor.process!.should == "I ******* **** bad language."
+  end
+  
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 5
+  - 9
   - 0
-  version: 0.5.0
+  version: 0.9.0
 platform: ruby
 authors: 
 - Josh Nesbitt
@@ -47,15 +47,12 @@ files:
 - TODO
 - VERSION
 - examples/all.rb
-- examples/one.txt
-- examples/output.txt
-- examples/text.textile
-- examples/two.txt
 - lib/processr.rb
 - processr.gemspec
 - readme.rdoc
-- spec/fixtures/one.js
-- spec/fixtures/two.js
+- spec/fixtures/one.txt
+- spec/fixtures/output.txt
+- spec/fixtures/two.txt
 - spec/lib/processr_spec.rb
 - spec/spec_helper.rb
 - spec/watch.rb

data/examples/output.txt

@@ -1 +0,0 @@
-A <em>simple</em> example of a <a href="http://www.textism.com/tools/textile/">textile</a> parser using a <strong>filter</strong>.

data/examples/text.textile

@@ -1 +0,0 @@
-A _simple_ example of a "textile":http://www.textism.com/tools/textile/ parser using a *filter*.

data/spec/fixtures/two.js

@@ -1 +0,0 @@
-two