hash_extend 1.1.3 → 1.2.0

data/README.md

@@ -22,7 +22,11 @@ Or install it yourself as:
 
 ## Usage
 
-### stealth_delete
+### stealth_delete -- Deprecated -> Use except
+
+method 'stealth_delete' is deprecated and will be deleted in version 2.4 - Use 'except' to fit Rails's ActiveSupport
+
+--
 
 Delete key(s) passed by, but return the hash instead of the deleted value
 
@@ -143,6 +147,31 @@ Code
 	end
 ```
 
+--
+
+FYI : ActiveSupport provide method 'slice'.
+
+```ruby
+	h = Hash[:one, 1, :two, 2, :three, 3]		#=> {:one=>1, :two=>2, :three=>3}
+	h.slice(:one, :three)						#=> {:three=>3, :one=>1}
+	h											#=> {:one=>1, :two=>2, :three=>3}
+	
+	h.slice(:six)								#=> {}
+```
+
+WARNING : slice! has not the same behavior. Check out ActiveSupport guides for more information : http://guides.rubyonrails.org/active_support_core_extensions.html
+
+--
+
+FYI : Rails 3's ActiveSupport provide method 'extract!'. (this gem provide method 'extract!' for Rails < 3)
+
+```ruby
+	h = Hash[:one, 1, :two, 2, :three, 3]		#=> {:one=>1, :two=>2, :three=>3}
+	h.extract!(:one, :three)					#=> {:one=>1, :three=>3}
+	h											#=> {:two=>2}
+	
+	h.extract!(:six)							#=> {:six=>nil}
+```
 
 ### insert
 
@@ -230,13 +259,19 @@ Code
 ```
 
 
-### select_by
+### select_by -- Deprecated -> Use except
+
+method 'select_by' is deprecated and will be deleted in version 2.4 - Use 'slice' to fit Rails's ActiveSupport
+
+method 'select_by!' is deprecated and will be deleted in version 2.4 - Use 'extract!' to fit Rails's ActiveSupport
+
+--
 
 Select into hash from a collection of keys. Usefull to select correct params after a form.
 
 ```ruby
-	select_by! *collection
-	select_by *collection
+	select_by! *keys
+	select_by *keys
 ```
 
 Demo
@@ -255,8 +290,40 @@ Demo
 Code
 
 ```ruby	
-	def select_by! *collection
-  		self.delete_if{ |field, _| !collection.include? field.to_sym }  
+	def select_by! *keys
+  		self.delete_if{ |field, _| !keys.include? field.to_sym }  
+	end
+```
+
+### extract -- Only for Rails < 3
+
+Select into hash from a collection of keys
+
+```ruby
+	extract! *keys
+```
+
+Demo
+
+```ruby
+	h = Hash[:one, 1, :two, 2, :three, 3]				#=> {:two=>2, :three=>3, :one=>1}
+	h.extract! :one, :three								#=> {:one=>1, :three=>3}
+	h													#=> {:two=>2}
+	
+	{:one=>1, :two=>2, :three=>3, :four=>4}.extract! :one, :six
+	#=> {:one=>1, :six=>nil}
+	
+	{:one=>1, :two=>2, :three=>3, :four=>4}.extract! :six, :seven
+	#=> {:six=>nil, :seven=>nil}
+```
+
+Code
+
+```ruby	
+	def extract! *keys
+  		hash = {}
+  		keys.each {|key| hash[key] = delete(key) }
+  		hash
 	end
 ```
 

data/lib/hash_extend.rb

@@ -1,49 +1,19 @@
 require "hash_extend/version"
 
 class Hash
-  
-  
-  unless method_defined? :except!
-    
-    def except! *keys
-      
-      p "is personnal methods"
-      
-      keys.each do |key|
-        delete key
-      end
-      return self
-    end
-    
-  end
-  
-  unless method_defined? :youpi
-    
-    def youpi
-      
-      p "youpi"
-
-    end
-    
-  end
-  
-  
-  
-  
-  
   # delete key(s) but return self instead of deleted value
   def stealth_delete! *keys
-    
+    warn "WARNING : method 'stealth_delete!' is deprecated and will be deleted in version X.Y - Use 'except!' to fit Rails' ActiveSupport"
     except! keys
-    warn "WARNING : 'stealth_delete!' is deprecated and will be deleted in version X.Y - Use 'extract!' to fit Rails 3's ActiveSupport"
   end
   
   def stealth_delete *keys
-    
-    except! keys
-    warn "WARNING : method 'stealth_delete' is deprecated and will be deleted in version X.Y - Use 'extract' to fit Rails 3's ActiveSupport"
+    warn "WARNING : method 'stealth_delete' is deprecated and will be deleted in version X.Y - Use 'except' to fit Rails' ActiveSupport"
+    except keys
   end
   
+  
+  
   # modify values from hash through block
   def map_values!
     self.each do |key, value|
@@ -105,13 +75,26 @@ class Hash
   end
     
   # something like #keep_if, but instead of block, pass collection of keys to select
-  def select_by! *collection
-    self.delete_if{ |field, _| !collection.include? field.to_sym }
+  def select_by! *keys
+    warn "WARNING : method 'select_by!' is deprecated and will be deleted in version 1.3 - Use 'extract!' to fit Rails's ActiveSupport"
+    self.delete_if{ |field, _| !keys.include? field.to_sym }
   end
   
+  def select_by *keys
+    warn "WARNING : method 'select_by' is deprecated and will be deleted in version 1.3 - Use 'slice' to fit Rails's ActiveSupport"
+    slice *keys
+  end
+  
+  unless method_defined? :extract!
+    def extract! *keys
+      hash = {}
+      keys.each {|key| hash[key] = delete(key) }
+      hash
+    end
+  end
   
   # duplicate method without self modification
-  [:except, :map_values, :compact, :select_by].each do |method_name|
+  [:map_values, :compact].each do |method_name|
     
     unless method_defined? method_name
     

data/lib/hash_extend/version.rb

@@ -1,3 +1,3 @@
 module HashExtend
-  VERSION = "1.1.3"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,23 +1,33 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: hash_extend
-version: !ruby/object:Gem::Version
-  version: 1.1.3
+version: !ruby/object:Gem::Version 
+  hash: 31
   prerelease: 
+  segments: 
+  - 1
+  - 2
+  - 0
+  version: 1.2.0
 platform: ruby
-authors:
+authors: 
 - Thomas Petrachi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-01 00:00:00.000000000 Z
+
+date: 2012-12-01 00:00:00 Z
 dependencies: []
+
 description: Extend ruby Hash. No override.
-email:
+email: 
 - thomas.petrachi@vodeclic.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - Gemfile
 - Gemfile.lock
@@ -30,28 +40,36 @@ files:
 - spec/lib/hash_extend_spec.rb
 homepage: https://github.com/petrachi/hash_extend
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Adding methods %w{stealth_delete map_values map_keys delete_many insert compact
-  select_by}
-test_files:
+summary: Adding methods %w{stealth_delete map_values map_keys delete_many insert compact select_by}
+test_files: 
 - spec/lib/hash_extend_spec.rb