cldwalker-alias 0.1.2 → 0.2.0

data/test/validator_test.rb

@@ -0,0 +1,72 @@
+require File.join(File.dirname(__FILE__), 'test_helper.rb')
+
+class Alias::ValidatorTest < Test::Unit::TestCase
+  context "Validator" do
+    before(:all) { eval "class ::TestCreator < Alias::Creator; end"}
+    before(:each) { Alias::Validator.instance_eval "@validators = {}"}
+
+    def validate(options={})
+      creator = TestCreator.new
+      options.each {|k,v| creator.send("#{k}=",v)}
+      @validator.validate(creator, {}, :blah)
+    end
+
+    def validator_message
+      @validator.create_message(:blah)
+    end
+
+    def create_validator(options)
+      @validator = TestCreator.valid :num, options
+    end
+
+    def create_parent_validator(key)
+      Alias::Validator.register_validators [{:key=>key, :if=>lambda {|e| 'yo'}, :message=>lambda {|e| 'cool'}}]
+      @parent_validator = Alias::Validator.validators[key]
+    end
+
+    test "copies a validator when using a previous one" do
+      create_parent_validator :num
+      create_validator :if=>:num
+      @parent_validator.validate(TestCreator.new, {}, :blah).should == validate
+    end
+
+    test "inherits a validator's message when using a previous one" do
+      create_parent_validator :num
+      create_validator :if=>:num
+      validator_message.should == 'cool'
+    end
+
+    test "overrides an inherited message with explicit message" do
+      create_parent_validator :num
+      create_validator :if=>:num, :message=>lambda {|e| 'cooler'}
+      validator_message.should == 'cooler'
+    end
+
+    test "sets a default message if an invalid one is given" do
+      create_validator :if=>lambda {|e| 'yo'}, :message=>:blah
+      validator_message.should =~ /Validation failed/
+    end
+
+    test "with :with option sets proc arg" do
+      create_validator :if=>lambda {|e| 'yo'}, :with=>[:a, :b]
+      @validator.validation_proc.expects(:call).with(['a','c'])
+      @validator.validate(TestCreator.new, {:a=>'a', :b=>'c', :c=>'d'}, :c)
+    end
+
+    test "with :unless option negates result and changes message" do
+      create_validator :unless=>lambda {|e| true }, :message=>lambda {|e| "yo doesn't exist"}
+      validate.should == false
+      validator_message.should == 'yo already exists'
+    end
+
+    test "with :optional option can be forced" do
+      create_validator :if=>lambda { false }, :optional=>true
+      validate(:force=>true).should == true
+    end
+
+    test "without :optional option cannot be forced" do
+      create_validator :if=>lambda { false }
+      validate(:force=>true).should == false
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cldwalker-alias
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -9,49 +9,54 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-23 00:00:00 -08:00
+date: 2009-07-07 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
-description: Provides aliases for class names, class methods, instance methods and more. Mainly for console use.
+description: Creates aliases for class methods, instance methods, constants, delegated methods and more. Aliases can be easily searched or saved as YAML config files to load later. Custom alias types are easy to create with the DSL Alias provides.  Although Alias was created with the irb user in mind, any Ruby console program can hook into Alias for creating configurable aliases.
 email: gabriel.horner@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README.rdoc
 - LICENSE.txt
+- README.rdoc
 files: 
+- CHANGELOG.rdoc
+- LICENSE.txt
+- README.rdoc
 - Rakefile
 - VERSION.yml
-- README.rdoc
-- LICENSE.txt
-- aliases.yml.example
-- lib/alias
-- lib/alias/class_method_creator.rb
+- lib/alias.rb
 - lib/alias/console.rb
-- lib/alias/constant_creator.rb
-- lib/alias/core_extensions.rb
 - lib/alias/creator.rb
-- lib/alias/instance_method_creator.rb
+- lib/alias/creators/any_to_instance_method_creator.rb
+- lib/alias/creators/class_method_creator.rb
+- lib/alias/creators/class_to_instance_method_creator.rb
+- lib/alias/creators/constant_creator.rb
+- lib/alias/creators/instance_method_creator.rb
 - lib/alias/manager.rb
-- lib/alias/method_creator_helper.rb
-- lib/alias.rb
-- lib/config_struct.rb
+- lib/alias/util.rb
+- lib/alias/validator.rb
 - test/alias_test.rb
 - test/aliases.yml
+- test/any_to_instance_method_creator_test.rb
+- test/class_method_creator_test.rb
+- test/class_to_instance_method_creator_test.rb
+- test/console_test.rb
 - test/constant_creator_test.rb
-- test/core_extensions_test.rb
 - test/creator_test.rb
+- test/instance_method_creator_test.rb
 - test/manager_test.rb
-- test/method_creator_helper_test.rb
 - test/test_helper.rb
+- test/util_test.rb
+- test/validator_test.rb
 has_rdoc: true
-homepage: http://github.com/cldwalker/alias
+homepage: http://tagaholic.me/alias/
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -71,7 +76,18 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
-summary: Provides aliases for class names, class methods, instance methods and more. Mainly for console use.
-test_files: []
-
+specification_version: 3
+summary: Creates, manages and saves aliases for class methods, instance methods, constants, delegated methods and more.
+test_files: 
+- test/alias_test.rb
+- test/any_to_instance_method_creator_test.rb
+- test/class_method_creator_test.rb
+- test/class_to_instance_method_creator_test.rb
+- test/console_test.rb
+- test/constant_creator_test.rb
+- test/creator_test.rb
+- test/instance_method_creator_test.rb
+- test/manager_test.rb
+- test/test_helper.rb
+- test/util_test.rb
+- test/validator_test.rb

data/aliases.yml.example

@@ -1,16 +0,0 @@
-verbose: true
-constant:
-    ActiveRecord::Base: AB
-    ActionView::Base: AVB
-  
-class_method:
-    ActiveRecord::Base : 
-      connection: cn
-      find: f
-      delete: d
-
-instance_method:
-    ActiveRecord::Base :
-      update_attribute: ua
-    Array : 
-      select: s 

data/lib/alias/class_method_creator.rb

@@ -1,9 +0,0 @@
-module Alias
-  class ClassMethodCreator < Creator
-    include Alias::MethodCreatorHelper
-    
-    def method_exists?(klass, method)
-      klass.respond_to?(method)
-    end
-  end
-end

data/lib/alias/constant_creator.rb

@@ -1,50 +0,0 @@
-module Alias
-  class ConstantCreator < Creator
-    
-    def delete_invalid_aliases(aliases_hash)
-      delete_invalid_class_keys(aliases_hash)
-    end
-    
-    def delete_existing_aliases(aliases_hash)
-      aliases_hash.each do |k, v| 
-        if (klass = Object.any_const_get(v)) && ! alias_map.values.include?(v)
-          aliases_hash.delete(k)
-          puts "Alias '#{v}' deleted since the constant already exists" if self.verbose
-        end
-      end
-    end
-    
-    def create_aliases(aliases_hash)
-      eval_string = ''
-      aliases_hash.each {|k,v|
-        eval_string += "#{v} = #{k}\n"
-      }
-      Object.class_eval eval_string
-    end
-    
-    def generate_aliases(array_to_alias)
-      make_shortest_aliases(array_to_alias)
-    end
-    
-    def to_searchable_array
-      @alias_map.map {|k,v| {:name=>k, :alias=>v}}
-    end
-    
-    def make_shortest_aliases(unaliased_strings)
-      shortest_aliases = {}
-      possible_alias = ''
-      unaliased_strings.each {|s|
-        possible_alias = ''
-        s.split('').each { |e|
-          possible_alias += e  
-          if ! shortest_aliases.values.include?(possible_alias)
-            shortest_aliases[s] = possible_alias
-            break
-          end
-        }
-      }
-
-      shortest_aliases
-    end
-  end
-end

data/lib/alias/core_extensions.rb

@@ -1,46 +0,0 @@
-class Hash
-  unless self.method_defined?(:slice)
-    # simplified from ActiveSupport
-    def slice(*keys)
-      reject { |key,| !keys.include?(key) }
-    end
-  end
-  
-  def slice_off!(*keys)
-    new_hash = slice(*keys)
-    keys.each {|e| self.delete(e)}
-    new_hash
-  end
-  
-  unless self.method_defined?(:stringify_keys)
-    #from ActiveSupport
-    def stringify_keys
-      inject({}) do |options, (key, value)|
-        options[key.to_s] = value
-        options
-      end
-    end
-  end
-  
-end
-
-class Object
-  def self.any_const_get(name)
-    begin
-    klass = Object
-    name.split('::').each {|e|
-      klass = klass.const_get(e)
-    }
-    klass
-    rescue; nil; end
-  end
-end
-
-class String
-  unless self.method_defined?(:camelize)
-    #simplified from ActiveSupport
-    def camelize
-      self.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
-    end
-  end
-end

data/lib/alias/instance_method_creator.rb

@@ -1,9 +0,0 @@
-module Alias
-  class InstanceMethodCreator < Creator
-    include Alias::MethodCreatorHelper
-    
-    def method_exists?(klass, method)
-      klass.method_defined?(method)
-    end
-  end
-end

data/lib/alias/method_creator_helper.rb

@@ -1,77 +0,0 @@
-module Alias
-  module MethodCreatorHelper
-    def delete_invalid_aliases(aliases_hash)
-      delete_invalid_class_keys(aliases_hash)
-      delete_invalid_method_keys(aliases_hash)
-    end
-    
-    def delete_existing_aliases(aliases_hash)
-      delete_existing_method_aliases(aliases_hash)
-    end
-    
-    def create_aliases(aliases_hash)
-      create_method_aliases(aliases_hash)
-    end
-    
-    def method_exists?(klass, method)
-      raise "This abstract method must be overridden."
-    end
-    
-    def delete_invalid_method_keys(alias_hash)
-      alias_hash.each do |k, methods|
-        if klass = Object.any_const_get(k)
-          methods.keys.each do |e|
-            if ! method_exists?(klass,e)
-              methods.delete(e)
-              puts "#{klass}: alias to method '#{e}' deleted since it doesn't exist" if self.verbose
-            end
-          end
-        end
-      end
-    end
-    
-    def delete_existing_method_aliases(aliases_hash)
-      aliases_hash.each do |k, methods_hash|
-        if klass = Object.any_const_get(k)
-          methods_hash.each do |a,b|
-            if method_exists?(klass,b) && !(alias_map[k].is_a?(Hash) && alias_map[k].values.include?(b))
-              methods_hash.delete(a)
-              puts "#{klass}: alias '#{b}' deleted since the method already exists" if self.verbose
-            end
-          end
-        end
-      end
-    end
-    
-    def to_searchable_array
-      @alias_map.map {|klass,method_hash|
-        method_hash.map {|k,v| 
-          {:class=>klass, :name=>k, :alias=>v}
-        }
-      }.flatten
-    end
-    
-    def create_method_aliases_per_class(klass, alias_hash)
-      eval_string = ""
-      alias_hash.each {|original_method, alias_methods|
-        alias_methods = [alias_methods] unless alias_methods.is_a?(Array)
-        alias_methods.each { |a|
-          eval_string += "alias_method :#{a}, :#{original_method}\n"
-        }
-      }
-      if self.is_a?(ClassMethodCreator)
-        eval_string = "class <<self\n #{eval_string}\nend"
-      end
-      klass.class_eval eval_string
-    end
-    
-    def create_method_aliases(aliases)
-      aliases ||= {}
-      aliases.each { |k,alias_hash|
-        if klass = Object.any_const_get(k)
-          create_method_aliases_per_class(klass, alias_hash)
-        end
-      }
-    end      
-  end
-end

data/lib/config_struct.rb

@@ -1,17 +0,0 @@
-require 'ostruct'
-
-class ConfigStruct < OpenStruct
-  def self.block_to_hash(block=nil)
-    config = self.new
-    if block
-      block.call(config)
-      config.to_hash
-    else
-      {}
-    end
-  end
-
-  def to_hash
-    @table
-  end
-end

data/test/core_extensions_test.rb

@@ -1,34 +0,0 @@
-require File.join(File.dirname(__FILE__), 'test_helper.rb')
-
-class Alias::CoreExtensionsTest < Test::Unit::TestCase
-  test "any_const_get fetches simple class" do
-    Object.any_const_get("Array").should == Array
-  end
-  
-  test "any_const_get fetches nested class" do
-    eval "module ::Somemodule; class Someclass; end; end"
-    Object.any_const_get("Somemodule::Someclass").should == Somemodule::Someclass
-  end
-  
-  test "any_const_get returns nil for nonexistent class" do
-    Object.any_const_get("NonexistentClass").should == nil
-  end
-  
-  test "slice only returns valid keys given" do
-    {:a=>1, :b=>2}.slice(:a, :c).should == {:a=>1}
-  end
-  
-  test "slice_off! returns given keys but takes them off existing hash" do
-    h = {:a=>1, :b=>2}
-    h.slice_off!(:a, :c).should == {:a=>1}
-    h.should == {:b=>2}
-  end
-  
-  test "camelize should uppercase non-underscored string" do
-    'man'.camelize.should == 'Man'
-  end
-  
-  test "camelize should camelize underscored string" do
-    'some_test'.camelize.should == 'SomeTest'
-  end
-end

data/test/method_creator_helper_test.rb

@@ -1,59 +0,0 @@
-require File.join(File.dirname(__FILE__), 'test_helper.rb')
-
-class Alias::MethodCreatorHelperTest < Test::Unit::TestCase
-  
-  context "ClassMethodCreator" do
-    before(:each) { @creator = Alias::ClassMethodCreator.new }
-    
-    test "deletes invalid class method keys" do
-      h1 = {'String'=>{'yaml_new'=>'yn'},'Array'=>{'blah'=>'bl'}}
-      @creator.delete_invalid_method_keys(h1)
-      h1.should == {"Array"=>{}, "String"=>{'yaml_new'=>'yn'}}
-    end
-  
-    test "deletes existing class method aliases" do
-      h1 = {'Date'=>{'civil_to_jd'=>'civil', 'valid_time?'=>'vt'} }
-      @creator.delete_existing_method_aliases(h1)
-      h1.should == {'Date'=>{'valid_time?'=>'vt'} }
-    end
-  
-    test "deletes existing class method unless it was created by the object" do
-      h1 = {'String'=>{'name'=>'n'}}
-      @creator.create(h1)
-      assert_not_equal 'blah', String.n
-      h2 = {'String'=>{'new'=>'n'}}
-      @creator.create(h2)
-      assert_equal 'blah', String.n('blah')
-    end
-    
-    test "to_searchable_array is an array of hashes" do
-      @creator.alias_map = {'String'=>{'name'=>'n'}}
-      @creator.to_searchable_array.should == [{:name=>'name', :alias=>'n', :class=>'String'}]
-    end
-  end
-  
-  context "InstanceMethodCreator" do
-    before(:each) { @creator = Alias::InstanceMethodCreator.new }
-    
-    test "deletes existing instance method aliases" do
-      h1 = {'String'=>{'strip'=>'st', 'chomp'=>'chop'}}
-      @creator.delete_existing_method_aliases(h1)
-      h1.should == {"String"=>{"strip"=>"st"}}
-    end
-    
-    test "deletes existing instance method unless it was created by the object" do
-      h1 = {'String'=>{'downcase'=>'d'}}
-      @creator.create(h1)
-      assert_not_equal 'bh', 'blah'.d
-      h2 = {'String'=>{'delete'=>'d'}}
-      @creator.create(h2)
-      assert_equal 'bh', 'blah'.d('la')
-    end
-  
-    test "deletes invalid instance method keys" do
-      h1 = {'String'=>{'strip'=>'st'},'Array'=>{'blah', 'bl'}}
-      @creator.delete_invalid_method_keys(h1)
-      h1.should == {"Array"=>{}, "String"=>{"strip"=>"st"}}
-    end
-  end
-end