namelogic 0.0.1

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.1.0"
+  gem "jeweler", "~> 1.8.3"
+  #gem "rcov", ">= 0"
+end
+
+gem 'htmlentities', '~>4.3.0'
+gem 'active_support'

data/Gemfile.lock

@@ -0,0 +1,37 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    active_support (3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    htmlentities (4.3.1)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.5)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_support
+  bundler (~> 1.1.0)
+  htmlentities (~> 4.3.0)
+  jeweler (~> 1.8.3)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)

data/README.rdoc

@@ -0,0 +1,7 @@
+
+== namelogic
+
+Wiki Segmented Name Logic
+
+== Abstract
+

data/Rakefile

@@ -0,0 +1,66 @@
+
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+
+VERSION = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+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'
+
+begin
+    require 'jeweler'
+    Jeweler::Tasks.new do |gem|
+      gem.name = 'namelogic'
+      gem.version = VERSION
+      gem.license = "MIT"
+      gem.summary = "Wiki Segmented Name Logic"
+      gem.email = "gerryg@inbox.com"
+      gem.homepage = "http://github.com/GerryG/namelogic/"
+      gem.description = "Wiki Segmented Name Logic"
+      gem.authors = ["Gerry Gleason <gerryg@inbox.com>"]
+      gem.files = FileList[
+        '[A-Z]*',
+        '*.rb',
+        'lib/**/*.rb',
+        'spec/**/*.rb' ].to_a
+      gem.test_files = Dir.glob('spec/*_spec.rb')
+      gem.has_rdoc = true
+      gem.extra_rdoc_files = [ "README.rdoc", "CHANGES" ]
+      gem.rdoc_options = ["--main", "README.rdoc", "--inline-source", "--line-numbers"]
+    end
+rescue LoadError
+    puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+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|
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "namelogic #{VERSION}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/name_logic.rb

@@ -0,0 +1,193 @@
+# -*- encoding : utf-8 -*-
+class NameLogic < String
+
+  # do: Object.send :include, NameLogic::ObjectMethods to enable x.to_name
+  module ObjectMethods
+    def to_name() NameLogic.new(self) end
+  end
+
+  require 'htmlentities'
+
+  class << self
+    attr_accessor :joint, :banned_array, :banned_re, :var_match,
+      :formal_joint, :uninflect, :name2nameobject
+  end
+
+  def method_missing meth, *args
+    if self.class.respond_to? meth
+      self.class.send meth, *args
+    else raise end
+  end
+
+
+  # Wagny defaults
+  JOINT             = ?+
+  BANNED_ARRAY      = [ ?/, ?~, ?| ]
+  BANNED_CHARACTERS = BANNED_ARRAY * ' '
+
+  VAR_MATCH         = /\{([^\}]*})\}/
+  WORD_RE           = RUBY_VERSION =~ /^1\.9/ ? '\p{Word}/' : '/\w/'
+  SINGULAR          = :singularize
+
+  @name2nameobject = {}
+
+  # reset these class instance vars to your system's to customize name syntax
+  @joint = JOINT
+  @formal_joint = " <span class=\"wiki-joint\">#{JOINT}</span> "
+  @banned_array = BANNED_ARRAY
+  @banned_re = /#{ ([?[] + @banned_array << @joint )*?\\ }#{ ?] }/
+  @var_match = VAR_MATCH
+  @uninflect = SINGULAR
+
+  class << self
+    def new obj
+      return obj if NameLogic===obj
+      str = Array===obj ? obj*joint : obj.to_s
+      return obj if obj = name2nameobject[str]
+      super str.strip
+    end
+
+    def user() '' end # override to fetch your user string for _user subs
+  end
+
+  attr_reader :simple, :parts, :key
+  alias to_key key
+
+  def initialize str
+    super str
+    #warn "init #{str.inspect}, #{inspect}, #{self.class.joint}, #{joint}"
+    @key = if index joint
+        @parts = str.split(/\s*#{Regexp.escape(joint)}\s*/)
+        @parts << '' if str[-1] == joint
+        @simple = false
+        @parts.map{|p| p.to_name.key } * joint  
+      else
+        @parts = [str]
+        @simple = true
+        empty? ? '' : generate_simple_key
+      end
+    name2nameobject[str] = self
+  end
+  
+  def generate_simple_key
+    decode_html.underscore.gsub(/[^#{WORD_RE}\*]+/,'_').split(/_+/).reject(&:empty?).map(&uninflect)*?_
+  end
+  
+  def decode_html
+    @decoded ||= (index(?&) ?  HTMLEntities.new.decode(to_s) : to_s)
+  end
+  
+  alias simple? simple
+  
+  def inspect() "<Name key=#{key}[#{self}, #{parts ? parts.size : 'no size'}]>" end
+
+  def self.unescape(uri) uri.gsub(' ','+').gsub('_',' ')             end
+
+  def self.substitute!( str, hash )
+    str.gsub!(var_match) { |x| (v=hash[var.to_sym]).nil? ? x : v }
+    str
+  end   
+
+  def ==(obj)
+    obj.nil? ? false :
+      key == (obj.respond_to?(:to_key) ? obj.to_key :
+             obj.respond_to?(:to_name) ? obj.to_name.key : obj.to_s)
+  end
+
+  def size()    parts.size                                end
+  def to_name() self                                      end
+  def valid?()  not parts.find {|pt| pt.match(banned_re)} end
+
+  def replace_part( oldpart, newpart )
+    oldpart = oldpart.to_name unless NameLogic===oldpart
+    newpart = newpart.to_name unless NameLogic===newpart
+    if oldpart.simple?
+      simple? ? (self == oldpart ? newpart : self) :
+                  parts.map{ |p| oldpart == p ? newpart : p }.to_name
+    elsif simple?
+      self
+    else
+      oldpart == parts[0, oldpart.size] ?
+        ((self.size == oldpart.size) ? newpart :
+           (newpart.parts+(parts[oldpart.size,].lines.to_a)).to_name) : self
+    end
+  end
+
+
+  def tag_name()      simple? ? self : parts[-1]                      end
+  def left_name()     simple? ? nil  : self.class.new(parts[0..-2])   end
+  def trunk_name()    simple? ? self : self.class.new(parts[0..-2])   end
+  def junction?()     not simple?                                     end
+  alias particle_names parts
+
+  def module_name()   gsub(/^\*/,'X_').gsub(/[\b\s]+/,'_').camelcase  end
+  def css_name()      @css_name ||= key.gsub('*','X').gsub('+','-')   end
+
+  def to_star()       star? ? self : ?*+self                          end
+  def star?()         simple? and self[0] == ?*                       end
+  def tag_star?()     junction? and ?* == parts[-1][0]                end
+  alias rstar? tag_star?
+  def star_rule(star)
+    star = star.to_s
+    [self, star.index(?*) ? star : ?*+star].to_name
+  end
+
+  alias blank? empty?
+
+  def pre_cgi()          parts * '~plus~'                            end
+  def escape()           gsub(' ','_')                               end
+
+  def to_url_key()
+    @url_key ||= decode_html.gsub(/[^\*#{WORD_RE}\s\+]/,' ').
+      strip.gsub(/[\s\_]+/,'_')
+  end
+
+  def piece_names()
+    simple? ? [self] : ([self] + trunk_name.piece_names + [tag_name]).uniq
+  end
+
+  def to_show(context)
+    # FIXME this is not quite right.  distinction is that is leaves blank parts blank.
+    (self =~/\b_(left|right|whole|self|user|main|\d+|L*R?)\b/) ?
+       to_absolute(context) : self
+  end
+
+  def escapeHTML(args)
+    args ? parts.map { |p| p =~ /^_/ and args[p] ? args[p] : p }*joint : self
+  end
+
+  def to_absolute_name(rel_name=nil)
+    (rel_name || self).to_name.to_absolute(self)
+  end
+
+  def nth_left(n)
+    (n >= size ? parts[0] : parts[0..-n-1]).to_name
+  end
+
+  def to_absolute(context, params=nil)
+    context = context.to_name
+    parts.map do |part|
+      new_part = case part
+        #when /^_user$/i;            user || part
+        when /^_main$/i;            Wagn::Conf[:main_name]
+        when /^(_self|_whole|_)$/i; context
+        when /^_left$/i;            context.trunk_name
+        when /^_right$/i;           context.tag_name
+        when /^_(\d+)$/i;
+          pos = $~[1].to_i
+          pos = context.size if pos > context.size
+          context.parts[pos-1]
+        when /^_(L*)(R?)$/i
+          l_s, r_s = $~[1].size, $~[2].empty?
+          trunk = context.nth_left(l_s)
+          r= r_s ? trunk.to_s : trunk.tag_name
+        when /^_/
+          (params && ppart = params[part]) ? CGI.escapeHTML( ppart ) : part
+        else                     part
+      end.strip
+      new_part.empty? ? context : new_part
+    end * joint
+  end
+
+end
+

data/spec/lib/name_logic_spec.rb

@@ -0,0 +1,194 @@
+# encoding: utf-8
+require File.expand_path('../spec_helper', File.dirname(__FILE__))
+
+describe NameLogic do
+  
+  describe "#to_key" do
+    it "should remove spaces" do
+      "This Name".to_name.to_key.should == "this_name"
+    end
+  
+    it "should singularize" do
+      "ethans".to_name.to_key.should == "ethan"
+    end                               
+  
+    it "should underscore" do 
+      "ThisThing".to_name.to_key.should == "this_thing"
+    end
+  
+    it "should handle plus cards" do
+      "ThisThing+Ethans".to_name.to_key.should == "this_thing+ethan"
+    end          
+  
+    it "should retain * for star cards" do
+      "*right".to_name.to_key.should == "*right"
+    end
+  
+    it "should not singularize double s's" do
+      "grass".to_name.to_key.should == 'grass'    
+    end
+    
+    it "should not singularize letter 'S'" do
+      'S'.to_name.to_key.should == 's'
+    end
+    
+    it "should handle unicode characters" do
+      "Mañana".to_name.to_key.should == 'mañana'
+    end
+    
+    it "should handle weird initial characters" do
+      '__you motha @#$'.to_name.to_key.should == 'you_motha'
+      '?!_you motha @#$'.to_name.to_key.should == 'you_motha'
+    end
+    
+    it "should allow numbers" do
+      "3way".to_name.to_key.should == '3way'
+    end
+    
+    it "internal plurals" do
+      "cards hooks label foos".to_name.to_key.should == 'card_hook_label_foo'
+    end
+
+    it "should handle html entities" do
+      # This no longer takes off the s, is singularize broken now?
+      "Jean-françois Noubel".to_name.to_key.should == 'jean_françoi_noubel'
+    end
+  end
+  
+  describe "#to_absolute" do
+    it "handles _self, _whole, _" do
+      "_self".to_name.to_absolute("foo").should == "foo"
+      "_whole".to_name.to_absolute("foo").should == "foo"
+      "_".to_name.to_absolute("foo").should == "foo"
+    end
+    
+    it "handles _left" do
+      "_left+Z".to_name.to_absolute("A+B+C").should == "A+B+Z"
+    end
+
+    it "handles white space" do
+      "_left + Z".to_name.to_absolute("A+B+C").should == "A+B+Z"
+    end
+    
+    it "handles _right" do
+      "_right+bang".to_name.to_absolute("nutter+butter").should == "butter+bang"
+      "C+_right".to_name.to_absolute("B+A").should == "C+A"
+    end
+    
+    it "handles leading +" do
+      "+bug".to_name.to_absolute("hum").should == "hum+bug"
+    end
+    
+    it "handles trailing +" do
+      "bug+".to_name.to_absolute("tracks").should == "bug+tracks"
+    end
+    
+    it "handles _(numbers)" do
+      "_1".to_name.to_absolute("A+B+C").should == "A"
+      "_1+_2".to_name.to_absolute("A+B+C").should == "A+B"
+      "_2+_3".to_name.to_absolute("A+B+C").should == "B+C"
+    end
+
+    it "handles _LLR etc" do
+      "_R".to_name.to_absolute("A+B+C+D+E").should    == "E"
+      "_L".to_name.to_absolute("A+B+C+D+E").should    == "A+B+C+D"
+      "_LR".to_name.to_absolute("A+B+C+D+E").should   == "D"
+      "_LL".to_name.to_absolute("A+B+C+D+E").should   == "A+B+C"
+      "_LLR".to_name.to_absolute("A+B+C+D+E").should  == "C"
+      "_LLL".to_name.to_absolute("A+B+C+D+E").should  == "A+B"
+      "_LLLR".to_name.to_absolute("A+B+C+D+E").should == "B"
+      "_LLLL".to_name.to_absolute("A+B+C+D+E").should == "A"
+    end
+    
+    context "mismatched requests" do
+      it "returns _self for _left or _right on non-junctions" do
+        "_left+Z".to_name.to_absolute("A").should == "A+Z"
+        "_right+Z".to_name.to_absolute("A").should == "A+Z"
+      end
+
+      it "handles bogus numbers" do
+        "_1".to_name.to_absolute("A").should == "A"
+        "_1+_2".to_name.to_absolute("A").should == "A+A"
+        "_2+_3".to_name.to_absolute("A").should == "A+A"
+      end
+      
+      it "handles bogus _llr requests" do
+           "_R".to_name.to_absolute("A").should == "A"
+           "_L".to_name.to_absolute("A").should == "A"
+          "_LR".to_name.to_absolute("A").should == "A"
+          "_LL".to_name.to_absolute("A").should == "A"
+         "_LLR".to_name.to_absolute("A").should == "A"
+         "_LLL".to_name.to_absolute("A").should == "A"
+        "_LLLR".to_name.to_absolute("A").should == "A"
+        "_LLLL".to_name.to_absolute("A").should == "A"
+      end
+    end
+  end
+  
+
+
+  describe "#to_url_key" do
+    cardnames = ["GrassCommons.org", 'Oh you @##', "Alice's Restaurant!", "PB & J", "Mañana"].map(&:to_name)
+  
+    cardnames.each do |cardname| 
+      it "should have the same key as the name" do
+        k, k2 = cardname.to_key, cardname.to_url_key
+        #warn "cn tok #{cardname.inspect}, #{k.inspect}, #{k2.inspect}"
+        k.should == k2.to_name.to_key
+      end
+    end
+  end       
+
+  describe "#valid" do
+    it "accepts valid names" do
+      "this+THAT".to_name.should be_valid
+      "THE*ONE*AND$!ONLY".to_name.should be_valid
+    end           
+    
+    it "rejects invalide names" do
+      "Tes~sd".to_name.should_not be_valid
+      "TEST/DDER".to_name.should_not be_valid
+    end
+  end         
+  
+  describe "#left_name" do
+    it "returns nil for non junction" do
+      "a".to_name.left_name.should == nil
+    end
+    
+    it "returns parent for parent" do
+      "a+b+c+d".to_name.left_name.should == "a+b+c"
+    end
+  end
+
+  describe "#tag_name" do
+    it "returns last part of plus card" do
+      "a+b+c".to_name.tag_name.should == "c"  
+    end
+    
+    it "returns name of simple card" do
+      "a".to_name.tag_name.should == "a"
+    end
+  end
+
+  describe "#css_name" do
+    it "subs pluses & stars" do
+      "Alpha?+*be-ta".to_name.css_name.should == "alpha-Xbe_tum"
+    end
+  end
+
+  describe "#replace_part" do
+    it "replaces first name part" do
+      'a+b'.to_name.replace_part('a','x').to_s.should == 'x+b'
+    end
+    it "replaces second name part" do
+      'a+b'.to_name.replace_part('b','x').to_s.should == 'a+x'
+    end
+    it "replaces two name parts" do
+      'a+b+c'.to_name.replace_part('a+b','x').to_s.should == 'x+c'
+    end
+    it "doesn't replace two part tag" do
+      'a+b+c'.to_name.replace_part('b+c','x').to_s.should == 'a+b+c'
+    end
+  end  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + "/../lib/name_logic")
+require 'active_support/inflector'
+
+# Add new inflection rules using the following format 
+ActiveSupport::Inflector.inflections do |inflect|
+   inflect.irregular 'grave', 'graveyard'
+   inflect.uncountable 'this'
+   #  inflect.uncountable 'plus'
+   inflect.uncountable 'anonymous'
+   inflect.uncountable /^s$/
+   inflect.singular(/(ss)$/i, '\1')
+   inflect.plural(/(ss)$/i, '\1')
+end
+
+Object.send :include, NameLogic::ObjectMethods

data/test.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+class MyString < String
+  def initialize s
+    super s.to_s
+    @simple = s.index(?+)
+    @s= s.to_s
+  end
+  def to_s() self end
+end
+
+x='foobar'
+
+puts "A string #{x}, and MyString: #{MyString.new(x)}, MyString.to_s: #{MyString.new(x).to_s}"

data/test2.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+class MyString < String
+  def initialize s
+    super s.to_s    # this line added
+    @s= s.to_s
+    @simple = s.index(?+)
+  end
+  def to_s() @s end
+end
+
+puts "#{MyString.new("foo")}"  # => produces "foo"

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: namelogic
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Gerry Gleason <gerryg@inbox.com>
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: htmlentities
+  requirement: &9304420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *9304420
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: &9303140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *9303140
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &9318660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *9318660
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &9317780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *9317780
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &9317080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *9317080
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &9314980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *9314980
+description: Wiki Segmented Name Logic
+email: gerryg@inbox.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/name_logic.rb
+- spec/lib/name_logic_spec.rb
+- spec/spec_helper.rb
+- test.rb
+- test2.rb
+homepage: http://github.com/GerryG/namelogic/
+licenses:
+- MIT
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+- --inline-source
+- --line-numbers
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4038131039544687550
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Wiki Segmented Name Logic
+test_files: []