detagger 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+  gem 'simplecov', :platforms => :mri_19
+  gem 'rcov', :platforms => :mri_18
+end
+
+gem "facets"

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 christfo
+
+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.rdoc

@@ -0,0 +1,19 @@
+= detagger
+
+Description goes here.
+
+== Contributing to detagger
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 christfo. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "detagger"
+  gem.homepage = "http://github.com/christfo/detagger"
+  gem.license = "MIT"
+  gem.summary = %Q{a library to 'detag' strings}
+  gem.description = %Q{This is intended to be used as a mixin, usualy with some kind of library that parses
+  optional command line arguments. The feature here is that the options may contain tags ('example_tag:') that
+  are not resolved until they are used. This means that one option may refer to another. An example might be:
+  --stage /tmp/fred --logfile stage:/my.log 
+  which would later provide a method 'logfile' that would return '/tmp/fred/my.log' }
+  gem.email = "chris.fordy@gmail.com"
+  gem.authors = ["christfo"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "detagger #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/detagger.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "detagger"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["christfo"]
+  s.date = "2012-03-13"
+  s.description = "This is intended to be used as a mixin, usualy with some kind of library that parses\n  optional command line arguments. The feature here is that the options may contain tags ('example_tag:') that\n  are not resolved until they are used. This means that one option may refer to another. An example might be:\n  --stage /tmp/fred --logfile stage:/my.log \n  which would later provide a method 'logfile' that would return '/tmp/fred/my.log' "
+  s.email = "chris.fordy@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "detagger.gemspec",
+    "lib/detagger.rb",
+    "spec/detagger_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/christfo/detagger"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "a library to 'detag' strings"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<facets>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<facets>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<facets>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/detagger.rb

@@ -0,0 +1,80 @@
+require 'rubygems'
+require 'facets/string'
+
+##
+# Mixin to allow paths and options to be described as 'tags:' that are only pocessed
+# when called for. the tag is satisfied by calls to self 
+module Detagger
+    attr_accessor :tagex
+
+    def drill_down_ref(txt,target = self)
+        return  unless txt 
+        parm = txt.chomp(":").to_sym
+        begin
+            new_txt = target.send(parm) 
+            raise "Self Reference" if new_txt == txt
+            new_txt
+        rescue NoMethodError
+            txt
+        end
+    end
+    
+    def detag( value, target = self, resolved = [] )
+        @tagex ||=  /([^\/:]+:)/
+
+        if ( value.respond_to? :call )
+            # manipulates self so that it is called with 'this' and not he context of the proc when defined
+            value = target.instance_eval &value
+        end
+
+        if value && value.is_a?(String) 
+            value = value.shatter(@tagex).flatten.map do |mtch|
+                if mtch =~ @tagex
+                    raise "Circular Reference" if resolved.include? mtch
+                    new_value = drill_down_ref(mtch,target)
+                    mtch == new_value ? new_value : detag(new_value, target, resolved + [mtch] )
+                else
+                    mtch
+                end
+            end
+            if (value.uniq == [nil]) 
+                value = nil
+            else
+                value = value.join
+            end
+        end
+        value
+    end
+
+    def method_missing( method, *args, &blk )
+        access, orig_method = *method.to_s.scan(/^(detag|raw)_(.+)$/).flatten
+        unless orig_method && self.respond_to?(orig_method.to_sym )
+            super(method,*args,&blk)
+        else
+            rawval = self.send( orig_method, *args, &blk ) 
+            (access == "detag") ? detag( rawval ) : rawval  
+        end
+    end
+    
+    def unless_flag( flag, &blk )
+        unless self.send("detag_#{flag}")
+            yield blk
+        else
+           puts "\033[31m!! Skipping step due to #{flag.to_s.quote} being true...\033[0m"
+           nil
+        end
+    end
+
+    def if_flag( flag, &blk )
+        if self.send( "detag_#{flag}" )
+            yield blk
+        else
+            puts "\033[31m!! Skipping step due to #{flag.to_s.quote} being false...\033[0m"
+            nil
+        end
+    end
+end
+
+
+
+

data/spec/detagger_spec.rb

@@ -0,0 +1,87 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Detagger do 
+    before( :each ) do
+        @options = Class.new do
+            def bob;     "henry" end
+            def sue;     "mary" end
+            def alfy;    "sue:" end
+            def jess;    "sue:/bob:some text/bob:text" end
+            def david;   "persue:" end
+            def kate;    "kate:" end
+            def rachel;  "phebs:" end
+            def phebs;   "rachel:" end
+            def greg;    "re/rachel:/henry:/fdgfd/   " end
+            def jenny;   ":alfy:sue:sue:david:" end
+        
+            def fred_;   "fred:" end
+            def al;      "al" end
+            def alfred;  "BAD" end
+            def bert;    "al:fred:/al:fred_:" end
+
+            def jim;    "" end
+            def soph;   nil end
+            def matt;   "soph:" end
+            def mike;   "sue:soph:sue:jim:" end
+
+            include Detagger
+        end.new
+        # @options.extend Detagger
+    end
+
+
+    it "has a detag mand drill_down_ref method" do
+        @options. should respond_to :detag
+        @options. should respond_to :drill_down_ref
+    end
+
+    it "will give a value for inputs" do
+        @options.bob.should  == "henry"
+        @options.sue.should  == "mary"
+    end
+
+    it "will raise when a method is missing" do
+        lambda { @options.broken }.should raise_error
+    end
+
+    it "will late bind 'tag' references" do
+        @options.detag_alfy.should_not == "sue:"
+        @options.detag_alfy.should     == @options.sue
+    end
+
+    it "will provide readers for raw values  of late bind 'tag' references" do
+        @options.raw_alfy.should     == "sue:"
+        @options.raw_alfy.should_not == @options.sue
+    end
+
+    it "will support multiple tags in a value" do
+        @options.detag_jess.should == "mary/henrysome text/henrytext"
+    end
+
+    it "will pass through unrecognised tags a plain text" do
+        @options.detag_david.should == "persue:"
+    end
+
+    it "will raise when circular references are found" do
+        lambda { @options.detag_kate }.should raise_error "Self Reference"
+        lambda { @options.detag_phebs }.should raise_error "Circular Reference"
+        lambda { @options.detag_greg }.should raise_error "Circular Reference"
+    end
+
+    it "will not be confused by multiple same tags" do
+        @options.detag_jenny.should == ":marymarymarypersue:"
+    end
+
+    it "will not compose new tags from resolved tags" do
+        @options.detag_bert.should_not == "BAD/BAD"
+        @options.detag_bert.should     == "alfred:/alfred:"
+    end
+
+    it "will gracefully handle flag values" do
+        @options.raw_jim.should    == ""
+        @options.raw_soph.should   == nil
+        @options.detag_soph.should == nil
+        @options.detag_matt.should == nil
+        @options.detag_mike.should == "marymary"
+    end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'detagger'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: detagger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- christfo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-13 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: facets
+  requirement: &2152557820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152557820
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152557020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *2152557020
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &2152556340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *2152556340
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2152555680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2152555680
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2152554980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *2152554980
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &2152554200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152554200
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2152553520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152553520
+description: ! "This is intended to be used as a mixin, usualy with some kind of library
+  that parses\n  optional command line arguments. The feature here is that the options
+  may contain tags ('example_tag:') that\n  are not resolved until they are used.
+  This means that one option may refer to another. An example might be:\n  --stage
+  /tmp/fred --logfile stage:/my.log \n  which would later provide a method 'logfile'
+  that would return '/tmp/fred/my.log' "
+email: chris.fordy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- detagger.gemspec
+- lib/detagger.rb
+- spec/detagger_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/christfo/detagger
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 130063977220471087
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: a library to 'detag' strings
+test_files: []