fetching 0.4.1 → 0.5.0

data/README.md

@@ -12,11 +12,13 @@ Fetching(HTTParty.get(url, query: query)).forms[0].request_form_id
 # fails loudly if the first `form` doesn't have a `request_form_id` key
 ```
 
+Or, if you prefer to learn from slide decks -- [As presented at RailsConf 2014](http://dapplebeforedawn.github.io/fetching-gem-talk)
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'fetching', git: 'https://github.com/covermymeds/fetching-gem.git'
+    gem 'fetching'
 
 And then execute:
 

data/lib/fetching/fetching_array.rb

@@ -0,0 +1,56 @@
+class Fetching
+  class FetchingArray < Fetching
+
+    include Enumerable
+
+    def [](index)
+      Fetching.from @table.fetch(index)
+    end
+
+    def each
+      @table.each_index do |i|
+        yield self[i]
+      end
+    end
+
+    def first
+      self[0]
+    end
+
+    module ArrayMethods
+
+      def empty?
+        @table.empty?
+      end
+
+      def length
+        @table.length
+      end
+      alias size length
+
+      def reverse
+        Fetching.from @table.reverse
+      end
+
+      def shuffle *args
+        Fetching.from @table.shuffle(*args)
+      end
+
+      def sort &block
+        Fetching.from @table.sort(&block)
+      end
+
+      def sort_by &block
+        Fetching.from @table.sort_by(&block)
+      end
+
+      def values_at *args
+        Fetching.from(args.map { |i| self[i] })
+      end
+
+    end
+
+    include ArrayMethods
+
+  end
+end

data/lib/fetching/fetching_hash.rb

@@ -0,0 +1,28 @@
+class Fetching
+  class FetchingHash < Fetching
+
+    def initialize *args
+      super
+      make_methods
+    end
+
+    def to_hash
+      @table.dup
+    end
+
+    private
+
+    def make_methods
+      @table.each do |k, v|
+        define_singleton_method(k) do
+          Fetching.from(v)
+        end
+      end
+    end
+
+    def method_missing key, *args, &block
+      fail NoMethodError, "#{key} not found\nyou have:\n#{@table.inspect}"
+    end
+
+  end
+end

data/lib/fetching/version.rb

@@ -1,3 +1,3 @@
 class Fetching
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/lib/fetching.rb

@@ -1,4 +1,6 @@
 require "json"
+require "fetching/fetching_array"
+require "fetching/fetching_hash"
 
 module Kernel
 
@@ -11,8 +13,9 @@ end
 class Fetching
 
   WHITELIST = %w[ define_singleton_method class object_id
-                  == inspect to_s instance_variables instance_eval
+                  == instance_variables instance_eval
                   instance_variable_get ]
+
   all_methods = instance_methods.map(&:to_s).grep(/\A[^_]/)
   (all_methods - WHITELIST).each(&method(:undef_method))
 
@@ -43,52 +46,12 @@ class Fetching
     self.class.hash ^ @table.hash
   end
 
-  private
-
-  def no_method key
-  end
-
-end
-
-class FetchingArray < Fetching
-
-  include Enumerable
-
-  def [](index)
-    Fetching.from @table.fetch(index)
-  end
-
-  def each
-    @table.each_index do |i|
-      yield self[i]
-    end
-  end
-
-end
-
-class FetchingHash < Fetching
-
-  def initialize *args
-    super
-    make_methods
-  end
-
-  def to_hash
-    @table.dup
-  end
-
-  private
-
-  def make_methods
-    @table.each do |k, v|
-      define_singleton_method(k) do
-        Fetching.from(v)
-      end
-    end
+  def to_s
+    @table.to_s
   end
 
-  def method_missing key, *args, &block
-    fail NoMethodError, "#{key} not found\nyou have:\n#{@table.inspect}"
+  def inspect
+    "#<#{self.class.name}: @table=#{to_s}>"
   end
 
 end

data/spec/fetching_array_spec.rb

@@ -0,0 +1,79 @@
+require "spec_helper"
+
+describe Fetching::FetchingArray do
+
+  specify "#map" do
+    ary = [1, 2]
+    fetching_ary = Fetching(ary)
+    expect(fetching_ary.map(&:to_s)).to eq(%w[1 2])
+  end
+
+  specify "Fetching should go deep" do
+    Fetching([{one: 1}]).each do |element|
+      expect(element.one).to eq(1)
+    end
+  end
+
+  specify "#first" do
+    ary = []
+    sassy_ary = Fetching(ary)
+    expect{ sassy_ary.first }.to raise_error(IndexError)
+  end
+
+  describe "array methods" do
+    let(:array)    { [1, 2, 3] }
+    let(:fetching) { Fetching(array) }
+
+    describe "#empty?" do
+      it("should be false"){ expect(fetching.empty?).to be_false }
+
+      context "when empty" do
+        let(:array) { [] }
+        it("should be true"){ expect(fetching.empty?).to be_true }
+      end
+    end
+
+    specify "#length" do
+      expect(fetching.length).to eq(array.length)
+      expect(fetching.size).to eq(array.size)
+    end
+
+    specify "#reverse" do
+      reversed = Fetching(array.reverse)
+      expect(fetching.reverse).to eq(reversed)
+    end
+
+    specify "#shuffle" do
+      seed = 1
+      shuffled = Fetching(array.shuffle(random: Random.new(seed)))
+      expect(fetching.shuffle(random: Random.new(seed))).to eq(shuffled)
+    end
+
+    specify "#sort" do
+      sorter = ->(x, y){ y <=> x }
+      sorted = Fetching(array.sort(&sorter))
+      expect(fetching.sort(&sorter)).to eq(sorted)
+    end
+
+    specify "#sort_by" do
+      sorter = ->(i){ 1/i.to_f }
+      sorted = Fetching(array.sort_by(&sorter))
+      expect(fetching.sort_by(&sorter)).to eq(sorted)
+    end
+
+    describe "#values_at" do
+      specify "happy path" do
+        at     = [0, 2]
+        values = Fetching(array.values_at(*at))
+        expect(fetching.values_at(*at)).to eq(values)
+      end
+      specify "out of bounds" do
+        at = 5
+        expected_message = "index #{at} outside of array bounds: -3...3"
+        expect{ fetching.values_at(at) }.to raise_error(IndexError, expected_message)
+      end
+    end
+
+  end
+
+end

data/spec/fetching_hash_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+describe Fetching::FetchingHash do
+
+  specify "#to_hash" do
+    hash = {one: 1, two: 2}
+    fetching_hash = Fetching(hash)
+    expect(fetching_hash.to_hash).to eq(hash)
+  end
+
+  specify "#to_hash doesn't allow you to break fetching" do
+    fetching_hash = Fetching(one: 1, two: 2)
+    hash = fetching_hash.to_hash
+    hash[:one] = ":)"
+    expect(fetching_hash.to_hash[:one]).to eq(1)
+  end
+
+  specify "#to_hash does a deep copy" do
+    hash = {one: 1, two: {three: 3}}
+    fetching_hash = Fetching(hash)
+    expect(fetching_hash.to_hash).to eq(hash)
+  end
+
+end

data/spec/fetching_spec.rb

@@ -37,42 +37,14 @@ describe Fetching do
     end
   end
 
-end
-
-describe FetchingHash do
-
-  specify "#to_hash" do
-    hash = {one: 1, two: 2}
-    sassy_hash = Fetching(hash)
-    expect(sassy_hash.to_hash).to eq(hash)
-  end
-
-  specify "#to_hash doesn't allow you to break fetching" do
-    sassy_hash = Fetching(one: 1, two: 2)
-    hash = sassy_hash.to_hash
-    hash[:one] = ":)"
-    expect(sassy_hash.to_hash[:one]).to eq(1)
-  end
-
-  specify "#to_hash does a deep copy" do
-    hash = {one: 1, two: {three: 3}}
-    sassy_hash = Fetching(hash)
-    expect(sassy_hash.to_hash).to eq(hash)
+  it "has a nice #to_s" do
+    nice_to_s = "{:one=>1, :two=>{\"two\"=>2}, :ary=>[1, 2], :object_ary=>[{}, {:three=>3}]}"
+    expect(subject.to_s).to eq(nice_to_s)
   end
 
-end
-
-describe FetchingArray do
-
-  specify "#map" do
-    ary = [1, 2]
-    sassy_ary = Fetching(ary)
-    expect(sassy_ary.map(&:to_s)).to eq(%w[1 2])
+  it "has a nice #inspect" do
+    nice_inspect = "#<Fetching::FetchingHash: @table={:one=>1, :two=>{\"two\"=>2}, :ary=>[1, 2], :object_ary=>[{}, {:three=>3}]}>"
+    expect(subject.inspect).to eq(nice_inspect)
   end
 
-  specify "Sassiness should go deep" do
-    Fetching([{one: 1}]).each do |element|
-      expect(element.one).to eq(1)
-    end
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fetching
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-24 00:00:00.000000000 Z
+date: 2014-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -91,7 +91,11 @@ files:
 - Rakefile
 - fetching.gemspec
 - lib/fetching.rb
+- lib/fetching/fetching_array.rb
+- lib/fetching/fetching_hash.rb
 - lib/fetching/version.rb
+- spec/fetching_array_spec.rb
+- spec/fetching_hash_spec.rb
 - spec/fetching_spec.rb
 - spec/spec_helper.rb
 - spec/support/vim_formatter.rb
@@ -123,6 +127,8 @@ summary: ! 'This gem is a work in progress.  The implementation code is not what
   important.  What is important: Don''t de-serialize API responses in to hashes and
   arrays.  Use a "strict" object that inforces key presence, and array bounds.}'
 test_files:
+- spec/fetching_array_spec.rb
+- spec/fetching_hash_spec.rb
 - spec/fetching_spec.rb
 - spec/spec_helper.rb
 - spec/support/vim_formatter.rb