stringtrain 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in stringtrain.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mark Seymour
+
+MIT License
+
+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/README.md

@@ -0,0 +1,49 @@
+# Stringtrain
+
+Stringtrain is a handy internal Ruby DSL for creating dynamically pieced-together strings.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'stringtrain'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stringtrain
+
+## Usage
+
+To use Stringtrain, create a new instance of the `Stringtrain::Cab` class, and pass a block to it. Or you can instantize it into a variable, and use the `#part` method separately.
+
+### Global options
+
+- `:part_separator`: A string that will serve as the delimiter between parts. Defaults to a whitespace character. (Defaults to `' '`)
+
+### Individual part options
+
+- `:condition`: An expression that returns true or false (or just an object). If the expression returns false, then the part does not get added. (Defaults to `true`)
+- `:prefix`: A string that appears before the part. (Defaults to `nil`)
+- `:suffix`: A string that appears after the part. (Defaults to `nil`)
+- `:surround_with`: A string or array that will be used around `string`. If it is an array, the first and last elements will be used for the left and right side of `string`. (Defaults to `' '`)
+
+### A simple example
+*See the [documentation](http://rubydoc.info/github/mseymour/stringtrain/Stringtrain/Cab:part) for more examples.* 
+
+    Stringtrain::Cab.new do
+      part 'A monkey loves to eat', suffix: '...'
+      part 'bananas', suffix: '!'
+    end
+    #=> "A monkey loves to eat... bananas!"
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/stringtrain.rb

@@ -0,0 +1,2 @@
+require "stringtrain/version"
+require "stringtrain/cab"

data/lib/stringtrain/cab.rb

@@ -0,0 +1,62 @@
+require "active_support/core_ext/object/blank"
+
+module Stringtrain
+  class Cab
+    attr_accessor :parts, :part_separator
+
+    # @param [Hash] opts Global options for the processor.
+    # @option opts [String] :part_separator (' ') A string that will be used as the delimiter between parts.
+    def initialize(opts={}, &block)
+      opts = { part_separator: ' ' }.merge(opts)
+      self.parts = []
+      self.part_separator = opts[:part_separator]
+      if block_given?
+        block.arity == 1 ? yield(self) : instance_eval(&block)
+      end
+    end
+
+    # @param [String] string A part of the resulting string.
+    # @param [Hash] opts Processing options for the part.
+    # @option opts [Boolean] :condition (true) An expression that returns true or false (or just an object). If the expression returns false, then the part does not get added.
+    # @option opts [String] :prefix (nil) A string that appears before the part.
+    # @option opts [String] :suffix (nil) A string that appears after the part.
+    # @option opts [String,Array] :surround_with (nil) A string or array that will be used around +string+. If it is an array, the first and last elements will be used for the left and right side of +string+.
+    # @example Adding two parts together with suffices
+    #   Stringtrain::Cab.new do
+    #     part 'A monkey loves to eat', suffix: '...'
+    #     part 'bananas', suffix: '!'
+    #   end
+    #   #=> "A monkey loves to eat... bananas!"
+    # @example A more complex usage example, making use of `:condition`, `:prefix`, `:suffix`, and `:surround_with`.
+    #   Stringtrain::Cab.new {|a|
+    #     a.part cd.current.tracknumber.to_s, surround_with: %w{# :}
+    #     a.part cd.current.artist, suffix: '-'
+    #     a.part cd.current.title
+    #     if cd.current.date
+    #       a.part '%s (%s)' % [cd.current.album, cd.current.date], surround_with: %w{[ ]}, condition: cd.current.album?
+    #     else
+    #       a.part cd.current.album, surround_with: %w{[ ]}, condition: cd.current.album?
+    #     end
+    #   }
+    #   #=> "#08: Loreena McKennitt - Dante's Prayer [The Book Of Secrets (1997)]"
+    def part(string, opts={})
+      opts = { condition: true, prefix: nil, suffix: nil, surround_with: nil }.merge(opts)
+      pieces = [opts[:prefix], string, opts[:suffix]]
+      part = if opts[:surround_with].respond_to?(:fetch)
+        pieces.insert(-1,opts[:surround_with].last)
+        pieces.insert(1,opts[:surround_with].first)
+        pieces.compact.join
+      else
+        pieces.compact.join(opts[:surround_with])
+      end
+      if !string.blank?
+        parts << part if opts[:condition]
+      end
+    end
+
+    # @return [String] The resultant string.
+    def to_s
+      parts.join(self.part_separator)
+    end
+  end
+end

data/lib/stringtrain/version.rb

@@ -0,0 +1,4 @@
+# @author Mark Seymour <mark.seymour.ns@gmail.com>
+module Stringtrain
+  VERSION = "0.0.1"
+end

data/stringtrain.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/stringtrain/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem "active_support"
+
+  gem.authors       = ["Mark Seymour"]
+  gem.email         = ["mark.seymour.ns@gmail.com"]
+  gem.description   = %q{A handly DSL for creating conditionally formatted strings.}
+  gem.summary       = %q{A cleaner way of making dynamically generated strings with conditions.}
+  gem.homepage      = "https://github.com/mseymour/stringtrain"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "stringtrain"
+  gem.require_paths = ["lib"]
+  gem.version       = Stringtrain::VERSION
+end

data/test/tc_output.rb

@@ -0,0 +1,31 @@
+require "stringtrain"
+require "test/unit"
+ 
+class TestStringtrain < Test::Unit::TestCase
+
+  def test_simple
+    simple = Stringtrain::Cab.new {
+      part "Artist"
+      part "Song name"
+      part "A time value"
+      part "Server Title"
+      part ''
+    }
+    assert_equal('Artist Song name A time value Server Title', simple.to_s)
+  end
+ 
+  def test_advanced
+    a_false_condition = false
+
+    advanced = Stringtrain::Cab.new(part_separator: '+') {|b|
+      b.part "Artist", suffix: '-'
+      b.part "Song name"
+      b.part "A time value", surround_with: ['(',')'], condition: a_false_condition
+      b.part "Server Title", prefix: '/'
+      b.part '', prefix: '/'
+    }
+
+    assert_equal('Artist -+Song name+/ Server Title', advanced.to_s)
+  end
+ 
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: stringtrain
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mark Seymour
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-21 00:00:00.000000000 Z
+dependencies: []
+description: A handly DSL for creating conditionally formatted strings.
+email:
+- mark.seymour.ns@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/stringtrain.rb
+- lib/stringtrain/cab.rb
+- lib/stringtrain/version.rb
+- stringtrain.gemspec
+- test/tc_output.rb
+homepage: https://github.com/mseymour/stringtrain
+licenses: []
+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.24
+signing_key: 
+specification_version: 3
+summary: A cleaner way of making dynamically generated strings with conditions.
+test_files:
+- test/tc_output.rb
+has_rdoc: