paranoid_starlight 1.2.0 → 1.3.0

data/README.md

@@ -2,9 +2,9 @@
 
 This piece of gem contains some custom validators and converters for ActiveModel.
 
-It have validations for email and name (European style).
+It has validations for email and name (European style).
 And validation and converter (to international format) of telephone number. (CZ/SK format)
-
+Few converters for texts and strings. Specs included.
 
 ## Installation
 
@@ -12,6 +12,10 @@ Add this line to your application's Gemfile:
 
     gem 'paranoid_starlight'
 
+If you want to have methods available for ActiveRecord models, use:
+    
+    gem 'paranoid_starlight', :require => 'paranoid_starlight/active_record'
+
 And then execute:
 
     $ bundle
@@ -34,21 +38,55 @@ Or install it yourself as:
     model.email = 'example@example.org'
     model.valid?
 
-or put this into /config/initializers/paranoid.rb
 
-    ActiveRecord::Base.send(:include, ParanoidStarlight::Validations)
-    ActiveRecord::Base.send(:include, ParanoidStarlight::Converters)
-
-Now you have them available globally for models
+If you required active_record hook, you can use:
 
     class Person < ActiveRecord::Base
-      attr_accessible :name, :telephone, :email
+      attr_accessible :name, :telephone, :mobile, :email
+      attr_accessible :address, :zip
+
       validates_email_format_of :email
       validates_name_format_of :name
-      validates_telephone_format_of :telephone
+      # few different valid formats are allowed
+      validates_telephone_format_of :telephone, :mobile
       # or validates :email, :email => true
 
-      before_save :convert_telephone_number(:telephone)
+      before_save :convert_fields
+      before_validation :process_fields
+
+      def convert_fields
+        # convert to international form
+        convert_telephone_number(:telephone)
+        convert_telephone_number(:mobile)
+        # or convert_telephone_number [:telephone, :mobile]
+        # do other things
+      end
+
+      def process_fields
+        clean_text([:address, :zip])
+      end
+    end
+
+Currently there are these possibilities:
+- validates_email_format_of
+- validates_name_format_of
+- validates_telephone_number_of
+
+- clean_text
+- clean_whitespaces
+- convert_telephone_number
+
+It is easy to create own converter, just do:
+
+    class Kiddie
+      include ::ParanoidStarlight::Converters
+      attr_accessor :name
+      
+      def l33t
+        basic_converter(self, :name) do |text|
+          text.gsub('e', '3')
+        end
+      end
     end
 
 
@@ -59,3 +97,9 @@ Now you have them available globally for models
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Author
+Created by Ivan Stana  
+License: MIT
+
+I encourage to write me something

data/lib/paranoid_starlight.rb

@@ -128,28 +128,51 @@ module ParanoidStarlight
       end
     end
     
+    def clean_whitespaces(inattr, outattr = '')
+      basic_converter(self, inattr, outattr) do |text|
+        text.to_s.gsub(/\s/, '')
+      end
+    end
+    
     private    
     def basic_converter(obj, inattr, outattr, &code)
-        unless obj.respond_to? inattr.to_sym
-          raise("Attribute #{inattr} does not exist.")
-        end
-        
-        outattr = inattr if outattr == ''
+      attributes = []
+      
+      # May be only one value, ideally string or symbol
+      outattr = outattr.to_sym
+      
+      
+      if inattr.is_a? Array
+        attributes = inattr
+      elsif obj.respond_to? inattr.to_sym
+        attributes << inattr
+        # hash, array and like haven't got to_sym defined
+        outattr = inattr if outattr.to_s == ''
+      else
+        raise("Attribute #{inattr} does not exist.")
+      end
+      
+      if attributes.size > 1 && outattr.to_s != ''
+        raise("Multiple attributes can be used only without output attribute")
+      end
+      
+      attributes.each do |attribute|
+        outattr = attribute if attributes.size > 1
         
-        unless obj.respond_to? outattr.to_sym
+        unless obj.respond_to? outattr
           raise("Attribute #{outattr} does not exist.")
         end
-        
+      
         setter = "#{outattr}=".to_sym
         unless obj.respond_to? setter
           raise("Setter #{setter} does not exist.")
         end
-        
-        to_convert = obj.send(inattr.to_sym)
+      
+        to_convert = obj.send(attribute.to_sym)
         unless to_convert.nil?
           obj.send(setter, code.call(to_convert))
         end
-        
+      end
     end
     
   end # end converters

data/lib/paranoid_starlight/version.rb

@@ -1,3 +1,3 @@
 module ParanoidStarlight
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/paranoid_starlight.gemspec

@@ -8,10 +8,12 @@ Gem::Specification.new do |gem|
   gem.version       = ParanoidStarlight::VERSION
   gem.author       = 'Ivan Stana'
   gem.email         = 'stiipa@centrum.sk'
-  gem.summary       = "Pack of custom validations and converters for ActiveModel"
+  gem.summary       = "Pack of custom validations and converters for ActiveModel. Or standalone."
   gem.description   = <<-EOF
-    Validators for name and email. Converter and validator for
-    telephone number (CZ/SK format). ActiveModel. Specs included.
+    It has validations for email and name (European style).
+    And validation and converter (to international format)
+    of telephone number. (CZ/SK format)
+    Few converters for texts and strings. Specs included.
   EOF
   
   gem.homepage      = "http://github.com/istana/paranoid_starlight"

data/specs/paranoid_starlight_spec.rb

@@ -8,7 +8,7 @@ class Fangirl
   include ::ParanoidStarlight::Converters
   attr_accessor :telephone
   attr_accessor :text
-  attr_accessor :basic_field, :basic_field_out
+  attr_accessor :basic_field, :basic_field2, :basic_field_out
 end
 
 describe ParanoidStarlight::Converters do
@@ -61,6 +61,7 @@ describe ParanoidStarlight::Converters do
     before do
       @test = Fangirl.new
       @test.basic_field = "Hello world!"
+      @test.basic_field2 = "World sends love to you!"
     
       def @test.upcase(input, output = '')
         basic_converter(self, input, output) do |text|
@@ -69,6 +70,22 @@ describe ParanoidStarlight::Converters do
       end
     end
     
+    context 'supplies parameters in different format' do
+      it 'should accept anything in input with to_s' do
+        @test.upcase(:basic_field)
+        @test.basic_field.should == "HELLO WORLD!"
+        @test.upcase('basic_field2')
+        @test.basic_field2.should == "WORLD SENDS LOVE TO YOU!"
+      end
+      
+      it 'should accept anything with to_s as output' do
+        @test.upcase(:basic_field, :basic_field_out)
+        @test.basic_field_out.should == "HELLO WORLD!"
+        @test.upcase('basic_field2', 'basic_field_out')
+        @test.basic_field_out.should == "WORLD SENDS LOVE TO YOU!"
+      end
+    end
+    
     context 'had one attribute supplied' do
       it 'should overwrite attribute' do
         @test.upcase(:basic_field)
@@ -84,6 +101,21 @@ describe ParanoidStarlight::Converters do
       end
     end
     
+    context 'had array of attributes supplied' do
+      it 'should convert all attributes of array' do
+        @test.upcase([:basic_field, :basic_field2])
+        @test.basic_field.should == "HELLO WORLD!"
+        @test.basic_field2.should == "WORLD SENDS LOVE TO YOU!"
+      end
+    end
+    
+    context 'had array of attributes and output supplied' do
+      it 'should raise error' do
+        expect {@test.upcase([:basic_field, :basic_field2],
+                 :basic_field_out) }.to raise_error(/Multiple attributes can/)
+      end
+    end
+    
   end
   
   
@@ -149,7 +181,7 @@ describe 'ParanoidStarlight::Validations' do
           'Ivan Stana', 'Ivan R. Stana', 'Ivan Ronon Stana',
           'Jean Claude Van Damme', 'Jean-Pierre Cassel',
           'Tatyana Sukhotina-Tolstaya',
-          'John R. R. Tolkien'
+          'John R. R. Tolkien', 'I S'
         ].each {
           |name| @name.validate_each(@mock, "name", name)
         }
@@ -158,7 +190,7 @@ describe 'ParanoidStarlight::Validations' do
       it "should validate invalid name" do
         @mock.errors[].should_receive('<<')
         [
-          'J. R. R. Tolkien', 'J.R.R. Tolkien', 'Tolkien'
+          'J. R. R. Tolkien', 'J.R.R. Tolkien', 'Tolkien', ''
         ].each {
           |name| @name.validate_each(@mock, "name", name)
         }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paranoid_starlight
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -75,8 +75,9 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! "    Validators for name and email. Converter and validator for\n    telephone
-  number (CZ/SK format). ActiveModel. Specs included.\n"
+description: ! "    It has validations for email and name (European style).\n    And
+  validation and converter (to international format)\n    of telephone number. (CZ/SK
+  format)\n    Few converters for texts and strings. Specs included.\n"
 email: stiipa@centrum.sk
 executables: []
 extensions: []
@@ -114,5 +115,5 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Pack of custom validations and converters for ActiveModel
+summary: Pack of custom validations and converters for ActiveModel. Or standalone.
 test_files: []