processr 0.5.0

data/.gitignore

@@ -0,0 +1 @@
+pkg/*

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Josh Nesbitt <josh@josh-nesbitt.net>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "processr"
+    gem.summary = "A simple text processing library"
+    gem.description = "Processr provides a really simple interface to processing a set of text files. Through the use of filters you can further modify output before writing the contents to a file."
+    gem.email = "josh@josh-nesbitt.net"
+    gem.homepage = "http://github.com/joshnesbitt/processr"
+    gem.authors = ["Josh Nesbitt"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "configurable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO

@@ -0,0 +1 @@
+* Add filters.

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/examples/all.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'processr'))
+
+Processr.configure do |config|
+  config.root = File.expand_path(File.dirname(__FILE__))
+  config.out  = File.join(config.root, 'output.txt')
+end
+
+
+
+# Simple text concatenation.
+
+processor = Processr.new
+processor << 'one.txt'
+processor << 'two.txt'
+processor.process!
+
+
+
+# Simple textile filter.
+
+TextileFilter = lambda do |buffer|
+  
+  lookup = {
+    /_(.*)_/         => '<em>\1</em>',
+    /\*(.*)\*/       => '<strong>\1</strong>',
+    /\"(.*)\":(\S*)/ => '<a href="\2">\1</a>'
+  }
+  
+  lookup.each_pair do |regex, replacement|
+    buffer.gsub!(regex, replacement)
+  end
+  
+  buffer
+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."

data/examples/one.txt

@@ -0,0 +1 @@
+one

data/examples/output.txt

@@ -0,0 +1 @@
+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

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

data/examples/two.txt

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

data/lib/processr.rb

@@ -0,0 +1,47 @@
+$:.unshift File.dirname(__FILE__)
+
+class Processr
+  class << self
+    def root=(path); @root = path; end
+    def root; @root; end
+    
+    def out=(path); @out = path; end
+    def out; @out; end
+    
+    def configure(&block)
+      yield self
+    end
+  end
+  
+  attr_accessor :buffer, :filters
+  
+  def initialize
+    self.buffer  = ""
+    self.filters = []
+  end
+  
+  def add_filter(filter)
+    self.filters << filter
+  end
+  
+  def process!
+    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
+  end
+  
+  private
+  def write_buffer!
+    output_file = File.open(self.class.out, "w+")
+    output_file.puts self.buffer
+    output_file.close
+  end
+end

data/processr.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{processr}
+  s.version = "0.5.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Josh Nesbitt"]
+  s.date = %q{2010-07-13}
+  s.description = %q{Processr provides a really simple interface to processing a set of text files. Through the use of filters you can further modify output before writing the contents to a file.}
+  s.email = %q{josh@josh-nesbitt.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "TODO"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "Rakefile",
+     "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/lib/processr_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/watch.rb"
+  ]
+  s.homepage = %q{http://github.com/joshnesbitt/processr}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A simple text processing library}
+  s.test_files = [
+    "spec/lib/processr_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/watch.rb",
+     "examples/all.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/readme.rdoc

@@ -0,0 +1,104 @@
+= Processr
+
+* Overview
+* Installation
+* Usage
+* Bugs
+
+
+
+== 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.
+
+== Installation
+
+The project is hosted on rubygems.org. Getting it is simple:
+
+  gem install processr
+
+== Usage
+
+=== Configuration
+
+Use the configuration block to setup Processr
+
+  Processr.configure do |config|
+    config.root = File.expand_path(File.dirname(__FILE__))
+    config.out  = File.join(config.root, 'output.txt')
+  end
+
+=== Basic
+
+  processor = Processr.new
+  processor << 'input_one.txt'
+  processor << 'input_two.txt'
+  processor.process!
+
+This will result in a single file being output with the contents of all files inputted.
+
+=== 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...
+  end
+
+Or
+
+  class MyFilter
+    
+    def self.call(buffer)
+      # ...do something with buffer here...
+    end
+    
+  end
+
+You can register a filter by calling #add_filter on an instance of Processr. A further example would be a really simple textile parser:
+  
+  TextileFilter = lambda do |buffer|
+    
+    lookup = {
+      /_(.*)_/         => '<em>\1</em>',
+      /\*(.*)\*/       => '<strong>\1</strong>',
+      /\"(.*)\":(\S*)/ => '<a href="\2">\1</a>'
+    }
+    
+    lookup.each_pair do |regex, replacement|
+      buffer.gsub!(regex, replacement)
+    end
+    
+    buffer
+  end
+  
+  processor = Processr.new
+  processor.add_filter(TextileFilter)
+  processor << 'text.textile'
+  processor.process!
+
+Run the examples for more information.
+
+
+
+== Bugs
+
+If you have any problems with processr, please file an issue at http://github.com/joshnesbitt/processr/issues.
+
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+
+
+== Copyright
+
+Copyright (c) 2010 Josh Nesbitt <josh@josh-nesbitt.net>. See LICENSE for details.

data/spec/fixtures/one.js

@@ -0,0 +1 @@
+one

data/spec/fixtures/two.js

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

data/spec/lib/processr_spec.rb

@@ -0,0 +1,34 @@
+describe Processr do
+  
+  before :all do
+    Processr.configure do |config|
+      config.root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+      config.out  = File.join(config.root, 'examples', 'all')
+    end
+  end
+  
+  it "should successfully accept a configuration block" do
+    root = nil
+    out  = nil
+    
+    Processr.configure do |config|
+      config.root = root
+      config.out  = out
+    end
+    
+    Processr.root.should be_nil
+    Processr.out.should be_nil
+    
+    root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+    out  = File.join(root, 'examples', 'all')
+    
+    Processr.configure do |config|
+      config.root = root
+      config.out  = out
+    end
+    
+    Processr.root.should == root
+    Processr.out.should  == out
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'processr'
+require 'spec'

data/spec/watch.rb

@@ -0,0 +1,28 @@
+# A simple alternative to autotest that isnt as painful
+
+options = {
+  :options => "--require 'spec/spec_helper' --format nested --color",
+  :binary => "spec"
+}
+
+watch("(lib|spec)/(.*)\.rb") do |match|
+  puts %x[ clear ]
+  
+  file   = match[match.size - 1]
+  opts   = options[:options]
+  binary = options[:binary]
+  
+  files = []
+  
+  ["spec/lib/*.rb", "spec/lib/*/*.rb"].each do |glob|
+    Dir.glob(glob).each { |f| files << f }
+  end
+  
+  puts "Found:"
+  files.each { |f| puts "+ #{f}" }
+  puts ""
+  command = "#{binary} #{files.collect! { |f| File.expand_path(f) }.join(" ")} #{opts}"
+  
+  system(command)
+  
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: processr
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
+platform: ruby
+authors: 
+- Josh Nesbitt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-13 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Processr provides a really simple interface to processing a set of text files. Through the use of filters you can further modify output before writing the contents to a file.
+email: josh@josh-nesbitt.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- TODO
+files: 
+- .gitignore
+- LICENSE
+- Rakefile
+- 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/lib/processr_spec.rb
+- spec/spec_helper.rb
+- spec/watch.rb
+has_rdoc: true
+homepage: http://github.com/joshnesbitt/processr
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A simple text processing library
+test_files: 
+- spec/lib/processr_spec.rb
+- spec/spec_helper.rb
+- spec/watch.rb
+- examples/all.rb