friendlyrange 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDAzYzIxMzU0Njg2MjgzNjg2ZGQxNWNlNzBjY2I1MWIxZWZlNDU3Ng==
+  data.tar.gz: !binary |-
+    MDNiMGUxMGQyODc1N2I4MTY0Yjk1N2E4MWMxOGE3OWE4NzdlMmYyZg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NmMwY2ViOGU5MWNhMDFhNjJhNzA3ZTJmNWVjNGQ5ZjRjYjc2OTI4YjllNGFm
+    ODgwNDE5MzU1MWQ5NDhiYTg4MzU1ZjQ1ZmZkMjk4Yjc3YmZiZmI5OWVkMmM1
+    MmMxY2VlNDAwY2Q4NjAwYjRkNWVlZThiYjc5ZTVmZTI4ZGE2NzM=
+  data.tar.gz: !binary |-
+    NWMyMTU2YjY3NTg1MzY0NmM4ZDVhZWQxMzczZTA0MDk3YmFlMWNjNzg5MWI3
+    ZWFlNmYzNGU3Y2E1ZjA0NTQ1YzQxYmFhYzI4NjNiOWMyNjQ5MDA1NTAyYjMz
+    MjE1MDU0NjU3Mzg5Y2YzNDQ1Y2IzMDkyYmNjYTBmY2MzYzgwYTQ=

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Tim Cheadle
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+# FriendlyRange
+
+FriendlyRange makes it easy to parse and compose ranges of numbers in a human friendly way.
+
+It allows you to easily accept multiple ranges as input, like `1-4, 9,
+15-19`. Just make sure ranges use hyphens and commas.
+
+### Installation
+
+Add to your `Gemfile`:
+
+```
+gem 'friendlyrange'
+```
+
+Or install manually:
+
+```
+$ gem install friendlyrange
+```
+
+### Usage
+
+To parse a human-input range of numbers:
+
+```
+range = FriendlyRange.new('1-4, 9, 11-13')
+```
+
+Now just use the range as an array:
+
+```
+range.to_a
+# => [1, 2, 3, 4, 9, 11, 12, 13]
+```
+
+Or, you can transform it back to a string:
+
+```
+range.to_s
+# => "1-4, 9, 11-13"
+```
+
+### Fun Stuff
+
+You can even take ranges in weird orders:
+
+```
+range = FriendlyRange.new('5-9, 1, 3')
+
+range.to_a
+# => [1, 3, 5, 6, 7, 8, 9]
+
+range.to_s
+# => "1, 3, 5-9"
+```
+
+It will even reconcile "bad" input, with overlapping numbers. It will
+deduplicate any numbers automatically.
+
+```
+range = FriendlyRange.new('1, 1-4, 4')
+
+range.to_a
+# => [1, 2, 3, 4]
+
+range.to_s
+#=> "1-4"
+```
+
+It will also compensate for crap input. Human friendly!
+
+```
+range = FriendlyRange.new('1    - 4  , 8-  9     , 10')
+
+range.to_a
+# => [1, 2, 3, 4, 8, 9, 10]
+
+range.to_s
+# => "1-4, 8-10"
+```
+
+### Feedback
+
+I'd love any feedback. Just file an issue or pull request. Please make sure any pull requests have tests for whatever you've changed.

data/lib/friendlyrange.rb

@@ -0,0 +1,69 @@
+class FriendlyRange
+  include Enumerable
+
+  def initialize(ranges_string)
+    @ranges_string = ranges_string
+    @ranges_array  = parse(@ranges_string)
+  end
+
+  def each(&block)
+    @ranges_array.each(&block)
+  end
+
+  def ==(other)
+    @ranges_array == other
+  end
+
+  def to_s
+    array_to_string_of_ranges(@ranges_array)
+  end
+
+  private
+
+  def parse(ranges_string)
+    tmp_array = []
+
+    ranges_string.split(/\s*,\s*/).each do |item|
+      if item =~ /(\d+)\s*-\s*(\d+)/
+        first, last = $1.to_i, $2.to_i
+        first, last = last, first if first > last
+        first.upto(last) { |rangeitem| tmp_array << rangeitem }
+      elsif item =~ /^\s*(\d+)\s*$/
+        tmp_array << item.to_i
+      else
+        raise ArgumentError, "Cannot parse '#{ranges_string}'"
+      end
+    end
+
+    tmp_array.sort.uniq
+  end
+
+  def array_to_string_of_ranges(ranges_array)
+    range_strings = []
+    range_start = range_end = ranges_array.sort[0]
+
+    ranges_array.drop(1).sort.each do |n|
+      if n == range_end + 1
+        # Number is sequential, extend the range
+        range_end = n
+      else
+        # Number is non-sequential, add the range
+        range_strings << range_string(range_start, range_end)
+        range_start = range_end = n
+      end
+    end
+
+    # Add the final range we found
+    range_strings << range_string(range_start, range_end)
+
+    range_strings.join(', ')
+  end
+
+  def range_string(range_start, range_end)
+    if range_start == range_end
+      range_start.to_s
+    else
+      "#{range_start}-#{range_end}"
+    end
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: friendlyrange
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Tim Cheadle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+description: FriendlyRange makes it easy to parse and compose ranges of numbers in
+  a human friendly way.
+email:
+- tim@rationalmeans.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/friendlyrange.rb
+- LICENSE.md
+- README.md
+homepage: http://github.com/timcheadle/friendlyrange
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: friendlyrange
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: An easy way to parse and compose human friendly number ranges
+test_files: []
+has_rdoc: