casual_support 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8914e689b15b07fbb5628b8745f9b1de4b5d65f3
-  data.tar.gz: 105d5b5411cb70b844f5ceb3c7ea17bd652e2d3f
+  metadata.gz: 2a1a0d4b85acc5ebea33e00189e06584cdba7c1d
+  data.tar.gz: f7622e76c1255b6058499d9fa96c5cfa23ba101e
 SHA512:
-  metadata.gz: 78de00d5d5e5d3c970f3747ec4131aa1fbd83ae361825d46f558e39198fd16fa72402d626a4d48da9c744baf578d1c0ff422403a5682ecfbaf0fde9ead0d5807
-  data.tar.gz: 1503f2ba9311fc72509d78f09bf91ae6a12b533465a135f6ef457160e21a97ead6e1f23ce72659b8bebb579e6e071228a6316947307f980ced38b94c7abed360
+  metadata.gz: 4938a0152fa5a60b49be69f3e76ac26a96e988478a789933de3d1ca999e05d38220d0b71f46e8f5909c230c264837b5053e84f405ad7a7bb3c8d11e13c7a87cd
+  data.tar.gz: ef2a424c9e9ef9bfb2039d7c3e02f2c736fffc9dd5fa274d8c231d6173ee29765e351d5f3e7df36852c843855893fcf3e47ec3d56475f4d0698504744db00529

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 TODO: Write your name
+Copyright (c) 2016 Jonathan Hefner
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,32 +1,67 @@
 # casual_support
 
-Utility methods as extensions to Ruby core objects.  Stuff I want in Active Support.
+Utility methods as extensions to Ruby core objects, a la Active Support.
+
+Also a nod to the epic [Facets] library, which has a vast quantity and
+wide variety of utility functions.  casual_support distinguishes itself
+in a few ways:
+
+- Focus on fast implementations.  See the benchmarks directory for
+  performance comparisons with typical and alternative implementations.
+- Low memory footprint without requiring cherry-picking.  Cherry-picking
+  is still possible though!
+- Intended to be used alongside Active Support.  Does not clash with
+  Active Support methods, and overrides only a few to provide more
+  performant implementations.
+
+[Facets]: https://github.com/rubyworks/facets
+
+
+## Utility Methods
+
+- Comparable
+  - [at_least](http://www.rubydoc.info/gems/casual_support/Comparable%3Aat_least)
+  - [at_most](http://www.rubydoc.info/gems/casual_support/Comparable%3Aat_most)
+  - [clamp](http://www.rubydoc.info/gems/casual_support/Comparable%3Aclamp)
+- Date
+  - [to_ymd](http://www.rubydoc.info/gems/casual_support/Date%3Ato_ymd)
+- Enumerable
+  - [duplicates](http://www.rubydoc.info/gems/casual_support/Enumerable%3Aduplicates)
+  - [index_to](http://www.rubydoc.info/gems/casual_support/Enumerable%3Aindex_to)
+- Hash
+  - [put!](http://www.rubydoc.info/gems/casual_support/Hash%3Aput%21)
+- Integer
+  - [to_hex](http://www.rubydoc.info/gems/casual_support/Integer%3Ato_hex)
+- String
+  - [after](http://www.rubydoc.info/gems/casual_support/String%3Aafter)
+  - [after_last](http://www.rubydoc.info/gems/casual_support/String%3Aafter_last)
+  - [before](http://www.rubydoc.info/gems/casual_support/String%3Abefore)
+  - [before_last](http://www.rubydoc.info/gems/casual_support/String%3Abefore_last)
+  - [between](http://www.rubydoc.info/gems/casual_support/String%3Abetween)
+  - [drop](http://www.rubydoc.info/gems/casual_support/String%3Adrop)
+  - [first](http://www.rubydoc.info/gems/casual_support/String%3Afirst)
+  - [from](http://www.rubydoc.info/gems/casual_support/String%3Afrom)
+  - [last](http://www.rubydoc.info/gems/casual_support/String%3Alast)
+  - [lchomp](http://www.rubydoc.info/gems/casual_support/String%3Alchomp)
+  - [prefix](http://www.rubydoc.info/gems/casual_support/String%3Aprefix)
+  - [suffix](http://www.rubydoc.info/gems/casual_support/String%3Asuffix)
+  - [to](http://www.rubydoc.info/gems/casual_support/String%3Ato)
+- Time
+  - [to_hms](http://www.rubydoc.info/gems/casual_support/Time%3Ato_hms)
+  - [to_ymd](http://www.rubydoc.info/gems/casual_support/Time%3Ato_ymd)
 
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'casual_support'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
     $ gem install casual_support
 
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Run `rake test` to run the tests.  You can also run `rake irb` for an
+interactive prompt that pre-loads the project code.
 
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+[MIT License](http://opensource.org/licenses/MIT)

data/Rakefile

@@ -1,5 +1,18 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "yard"
+
+
+desc "Launch IRB with this gem pre-loaded"
+task :irb do
+  require "casual_support"
+  require "irb"
+  ARGV.clear
+  IRB.start
+end
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+end
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"

data/benchmarks/comparable/at_least.rb

@@ -0,0 +1,9 @@
+require 'benchmark/inputs'
+require_relative '../../lib/casual_support'
+
+
+Benchmark.inputs([*1..10]) do |job|
+  job.report('Comparable#at_least'){|i| i.at_least(5) }
+  job.report('Array#max'){|i| [i, 5].max }
+  job.compare!
+end

data/benchmarks/comparable/at_most.rb

@@ -0,0 +1,9 @@
+require 'benchmark/inputs'
+require_relative '../../lib/casual_support'
+
+
+Benchmark.inputs([*1..10]) do |job|
+  job.report('Comparable#at_most'){|i| i.at_most(5) }
+  job.report('Array#min'){|i| [i, 5].min }
+  job.compare!
+end

data/benchmarks/hash/putbang.rb

@@ -0,0 +1,13 @@
+require 'benchmark/inputs'
+require_relative '../../lib/casual_support'
+
+
+Benchmark.inputs([[1], [*1..10], [*1..100]]) do |job|
+  job.report('reduce{ put! }') do |ary|
+    ary.reduce({}){|h, i| h.put!(i, i) }
+  end
+  job.report('reduce{ merge! }') do |ary|
+    ary.reduce({}){|h, i| h.merge!(i => i) }
+  end
+  job.compare!
+end

data/benchmarks/integer/to_hex.rb

@@ -0,0 +1,34 @@
+require 'benchmark/inputs'
+require_relative '../../lib/casual_support'
+
+
+class Integer
+
+  def to_hex_alt1(width = nil)
+    h = self.to_s(16)
+    width ? h.rjust(width, '0'.freeze) : h
+  end
+
+  def to_hex_alt2(width = 0)
+    h = self.to_s(16)
+    width > h.length ? h.rjust(width, '0'.freeze) : h
+  end
+
+end
+
+
+Benchmark.inputs([*0..8]) do |job|
+  job.report('Integer#to_hex'){|width| (210).to_hex(width) }
+  job.report('Integer#to_hex_alt1'){|width| (210).to_hex_alt1(width) }
+  job.report('Integer#to_hex_alt2'){|width| (210).to_hex_alt2(width) }
+  job.report('sprintf'){|width| sprintf("%0#{width}x", 210) }
+  job.compare!
+end
+
+Benchmark.inputs([nil]) do |job|
+  job.report('Integer#to_hex'){|width| (210).to_hex }
+  job.report('Integer#to_hex_alt1'){|width| (210).to_hex_alt1 }
+  job.report('Integer#to_hex_alt2'){|width| (210).to_hex_alt2 }
+  job.report('Integer#to_s'){|width| (210).to_s(16) }
+  job.compare!
+end

data/benchmarks/string/after.rb

@@ -0,0 +1,22 @@
+require 'benchmark/inputs'
+require_relative '../../lib/casual_support'
+
+
+class String
+
+  def after_alt1(delim)
+    i = self.index(delim)
+    i && self.drop(i + delim.length)
+  end
+
+end
+
+
+STRING = 'abcnoonxyz'
+
+Benchmark.inputs(STRING.chars << '_') do |job|
+  job.report('String#after'){|delim| STRING.after(delim) }
+  job.report('String#after_alt1'){|delim| STRING.after_alt1(delim) }
+  job.report('String#split'){|delim| STRING.split(delim, 2)[1] }
+  job.compare!
+end

data/benchmarks/string/after_last.rb

@@ -0,0 +1,22 @@
+require 'benchmark/inputs'
+require_relative '../../lib/casual_support'
+
+
+class String
+
+  def after_last_alt1(delim)
+    i = self.rindex(delim)
+    i && self.drop(i + delim.length)
+  end
+
+end
+
+
+STRING = 'abcnoonxyz'
+
+Benchmark.inputs(STRING.chars << '_') do |job|
+  job.report('String#after_last'){|delim| STRING.after_last(delim) }
+  job.report('String#after_last_alt1'){|delim| STRING.after_last_alt1(delim) }
+  job.report('String#split'){|delim| STRING.split(delim, -1).drop(1).last }
+  job.compare!
+end

data/benchmarks/string/before.rb

@@ -0,0 +1,23 @@
+require 'benchmark/inputs'
+require_relative '../../lib/casual_support'
+
+
+class String
+
+  def before_alt1(delim)
+    i = self.index(delim)
+    i ? self.first(i) : self.dup
+  end
+
+end
+
+
+
+STRING = 'abcnoonxyz'
+
+Benchmark.inputs(STRING.chars << '_') do |job|
+  job.report('String#before'){|delim| STRING.before(delim) }
+  job.report('String#before_alt1'){|delim| STRING.before_alt1(delim) }
+  job.report('String#split'){|delim| STRING.split(delim, 2).first }
+  job.compare!
+end

data/benchmarks/string/before_last.rb

@@ -0,0 +1,22 @@
+require 'benchmark/inputs'
+require_relative '../../lib/casual_support'
+
+
+class String
+
+  def before_last_alt1(delim)
+    i = self.rindex(delim)
+    i ? self.first(i) : self.dup
+  end
+
+end
+
+
+STRING = 'abcnoonxyz'
+
+Benchmark.inputs(STRING.chars << '_') do |job|
+  job.report('String#before_last'){|delim| STRING.before_last(delim) }
+  job.report('String#before_last_alt1'){|delim| STRING.before_last_alt1(delim) }
+  job.report('String#split'){|delim| STRING.split(delim, -1)[0..-2].join(delim) }
+  job.compare!
+end

data/benchmarks/string/between.rb

@@ -0,0 +1,21 @@
+require 'benchmark/inputs'
+require_relative '../../lib/casual_support'
+
+
+class String
+
+  def between_alt1(open, close)
+    s = self.after(open)
+    s && s.before(close) # fails to return nil if `close` is missing
+  end
+
+end
+
+
+STRING = 'key="111-delim-222-delim-333"'
+
+Benchmark.inputs(['"', '-delim-', '!']) do |job|
+  job.report('String#between'){|delim| STRING.between(delim, delim) }
+  job.report('String#between_alt1'){|delim| STRING.between_alt1(delim, delim) }
+  job.compare!
+end

data/benchmarks/string/drop.rb

@@ -0,0 +1,18 @@
+require 'benchmark/inputs'
+require_relative '../../lib/casual_support'
+
+
+class String
+  def drop_alt1(n)
+    self[n.constrain(0, self.length), self.length]
+  end
+end
+
+
+STRING = 'abcdef'
+
+Benchmark.inputs([*0..(STRING.length + 1)]) do |job|
+  job.report('String#drop'){|n| STRING.drop(n) }
+  job.report('String#drop_alt1'){|n| STRING.drop_alt1(n) }
+  job.compare!
+end

data/benchmarks/string/first.rb

@@ -0,0 +1,23 @@
+require 'benchmark/inputs'
+require 'active_support/all'
+class String
+  alias_method :old_first, :first
+end
+require_relative '../../lib/casual_support'
+
+
+class String
+  def first_alt1(limit = 1)
+    limit <= 0 ? '' : self[0, limit]
+  end
+end
+
+
+STRING = 'abcdef'
+
+Benchmark.inputs([*0..(STRING.length + 1)]) do |job|
+  job.report('casual_support String#first'){|n| STRING.first(n) }
+  job.report('casual_support String#first_alt1'){|n| STRING.first_alt1(n) }
+  job.report('active_support String#first'){|n| STRING.old_first(n) }
+  job.compare!
+end

data/benchmarks/string/from.rb

@@ -0,0 +1,15 @@
+require 'benchmark/inputs'
+require 'active_support/all'
+class String
+  alias_method :old_from, :from
+end
+require_relative '../../lib/casual_support'
+
+
+STRING = 'abcdef'
+
+Benchmark.inputs([*0..(STRING.length + 1)]) do |job|
+  job.report('casual_support String#from'){|n| STRING.from(n) }
+  job.report('active_support String#from'){|n| STRING.old_from(n) }
+  job.compare!
+end

data/benchmarks/string/last.rb

@@ -0,0 +1,15 @@
+require 'benchmark/inputs'
+require 'active_support/all'
+class String
+  alias_method :old_last, :last
+end
+require_relative '../../lib/casual_support'
+
+
+STRING = 'abcdef'
+
+Benchmark.inputs([*0..(STRING.length + 1)]) do |job|
+  job.report('casual_support String#last'){|n| STRING.last(n) }
+  job.report('active_support String#last'){|n| STRING.old_last(n) }
+  job.compare!
+end

data/benchmarks/string/prefix.rb

@@ -0,0 +1,12 @@
+require 'benchmark/inputs'
+require_relative '../../lib/casual_support'
+
+
+PREFIX = 'abc'
+PREFIX_REGEX = /^(?!abc)/
+
+Benchmark.inputs(['xyz', 'abxyz', 'abcxyz', '']) do |job|
+  job.report('String#prefix'){|s| s.prefix(PREFIX) }
+  job.report('String#gsub'){|s| s.gsub(PREFIX_REGEX, PREFIX) }
+  job.compare!
+end

data/benchmarks/string/suffix.rb

@@ -0,0 +1,12 @@
+require 'benchmark/inputs'
+require_relative '../../lib/casual_support'
+
+
+SUFFIX = 'xyz'
+SUFFIX_REGEX = /^(?!xyz)/
+
+Benchmark.inputs(['abc', 'abcyz', 'abcxyz', '']) do |job|
+  job.report('String#suffix'){|s| s.suffix(SUFFIX) }
+  job.report('String#gsub'){|s| s.gsub(SUFFIX_REGEX, SUFFIX) }
+  job.compare!
+end

data/benchmarks/string/to.rb

@@ -0,0 +1,15 @@
+require 'benchmark/inputs'
+require 'active_support/all'
+class String
+  alias_method :old_to, :to
+end
+require_relative '../../lib/casual_support'
+
+
+STRING = 'abcdef'
+
+Benchmark.inputs([*0..(STRING.length + 1)]) do |job|
+  job.report('casual_support String#to'){|n| STRING.to(n) }
+  job.report('active_support String#to'){|n| STRING.old_to(n) }
+  job.compare!
+end

data/benchmarks/time/to_hms.rb

@@ -0,0 +1,12 @@
+require 'benchmark/inputs'
+require_relative '../../lib/casual_support'
+
+
+FORMAT = '%H:%M:%S'
+
+Benchmark.inputs([Time.new(1999, 12, 31, 23, 59, 59)]) do |job|
+  job.report('Time#to_hms'){|t| t.to_hms }
+  job.report('Time#strftime'){|t| t.strftime('%H:%M:%S') }
+  job.report('Time#strftime(CONST)'){|t| t.strftime(FORMAT) }
+  job.compare!
+end