fake_friends 1.0.1 → 1.0.3

data/lib/fake_friends/version.rb

@@ -1,3 +1,3 @@
 module FakeFriends
-  VERSION = "1.0.1"
+  VERSION = '1.0.3'
 end

data/lib/fake_friends.rb

@@ -9,10 +9,18 @@ module FakeFriends
   class FakeFriend
     attr_reader :username, :name, :location, :description, :url, :posts
 
+    # Public: FakeFriend.all
+    #
+    # Returns a class instance Hash variable holding the
+    #   user list defined in users.yml
+    def self.all
+      @friends_list
+    end
+
     # Public: FakeFriend.gather(n)
     # Returns n FakeFriend objects
     #
-    # n  - An Integer from 1 to 101.
+    # n  - An Integer from 1 to 100.
     #
     # Examples
     #
@@ -21,8 +29,8 @@ module FakeFriends
     #
     # Returns an array of n FakeFriend objects
     def self.gather(n)
-      raise ArgumentError, "Can only gather 1 to 101 FakeFriends" unless n.between?(1, 101)
-      users = FakeFriend.list.keys.sample(n)
+      raise ArgumentError, "Can only gather 1 to 100 FakeFriends" unless n.between?(1, 100)
+      users = FakeFriend.all.keys.sample(n)
       users.map{ |username| FakeFriend.new(username) }
     end
 
@@ -30,7 +38,7 @@ module FakeFriends
     # Returns a FakeFriend object for a specific user in the user listing
     #
     # options - The Hash of options (default: {}):
-    #           :id - Integer - User's position in the user listing, 1 to 101
+    #           :id - Integer - User's position in the user listing, 1 to 100
     #           :username - String - User's Twitter username
     #
     # Examples
@@ -40,10 +48,10 @@ module FakeFriends
     #
     # Returns the requested FakeFriend object if found, else raises ArgumentError
     def self.find_by(options)
-      if options[:id] && options[:id].between?(1, FakeFriend.list.count)
-        username = FakeFriend.list.keys[options[:id]-1]
+      if options[:id] && options[:id].between?(1, FakeFriend.all.count)
+        username = FakeFriend.all.keys[options[:id]-1]
         FakeFriend.new(username)
-      elsif options[:username] && FakeFriend.list.keys.include?(options[:username])
+      elsif options[:username] && FakeFriend.all.keys.include?(options[:username])
         FakeFriend.new(options[:username])
       else
         raise ArgumentError, "Requested user not found in library."
@@ -52,7 +60,7 @@ module FakeFriends
 
     # Public: FakeFriend.new(username)
     # Creates a FakeFriend object with attributes fetched from
-    # the user listing defined in users.yml and accesses via FakeFriend.list
+    # the user listing defined in users.yml and accesses via FakeFriend.all
     #
     # username  - String - a Twitter username found in the user listing
     #
@@ -61,14 +69,14 @@ module FakeFriends
     #   FakeFriend.new('idiot')
     #   # => #<FakeFriend:0x00000101348a80 @username="idiot"...>
     #
-    # Returns a FakeFriend object with attributes populated from FakeFriend.list
+    # Returns a FakeFriend object with attributes populated from FakeFriend.all
     def initialize(username)
       @username    = username
-      @name        = FakeFriend.list[username][:name]
-      @location    = FakeFriend.list[username][:location]
-      @description = FakeFriend.list[username][:description]
-      @url         = FakeFriend.list[username][:url]
-      @posts       = FakeFriend.list[username][:posts]
+      @name        = FakeFriend.all[username][:name]
+      @location    = FakeFriend.all[username][:location]
+      @description = FakeFriend.all[username][:description]
+      @url         = FakeFriend.all[username][:url]
+      @posts       = FakeFriend.all[username][:posts]
     end
 
     # Public: returns a user's uiFaces url in the closest available size
@@ -82,18 +90,16 @@ module FakeFriends
       "https://s3.amazonaws.com/uifaces/faces/twitter/#{username}/#{size}.jpg"
     end
 
+
     private
-      mydir         = File.expand_path(File.dirname(__FILE__))
-      libary_file   = mydir + '/fake_friends/users.yml'
-      @friends_list = File.open(libary_file, 'r'){|f| YAML.load(f) }
 
-      # Private: FakeFriend.list
-      #
-      # Returns a class instance Hash variable holding the
-      #   user list defined in users.yml
-      def self.list
-        @friends_list
-      end
+    def self.populate_friends_list
+      project_lib   = File.expand_path(File.dirname(__FILE__))
+      library_file  = "#{project_lib}/fake_friends/users.yml"
+      File.open(library_file, 'r'){|f| YAML.load(f) }
+    end
+
+    @friends_list = populate_friends_list
   end
 
 end

data/spec/fake_friends_spec.rb

@@ -2,70 +2,69 @@ require 'spec_helper'
 include FakeFriends
 
 describe FakeFriend do
+  describe '::gather' do
+    context 'with valid input' do
+      let(:users) { FakeFriend.gather(5) }
 
-  describe "::gather" do
-    context "with valid input" do
-      let(:users){ FakeFriend.gather(5) }
-
-      it "returns an array of FakeFriends" do
+      it 'returns an array of FakeFriends' do
         expect(users).to be_an Array
         expect(users).to be_composed_of FakeFriend
       end
 
-      it "returns the requested number of FakeFriends" do
+      it 'returns the requested number of FakeFriends' do
         expect(users.count).to be 5
       end
 
-      it "does not return duplicates" do
+      it 'does not return duplicates' do
         expect(users.count).to be users.map(&:username).uniq.count
       end
     end
 
-    context "with invalid input" do
-      describe "with a negative number" do
+    context 'with invalid input' do
+      describe 'with a negative number' do
         it { expect { FakeFriend.gather(-1) }.to raise_error(ArgumentError) }
       end
-      describe "with too high a number" do
-        it { expect { FakeFriend.gather(102) }.to raise_error(ArgumentError) }
+      describe 'with too high a number' do
+        it { expect { FakeFriend.gather(101) }.to raise_error(ArgumentError) }
       end
     end
   end
 
+  describe '::find_by' do
+    context 'with valid input (by id)' do
+      let(:user) { FakeFriend.find_by(id: 1) }
 
-  describe "::find_by" do
-    context "with valid input (by id)" do
-      let(:user){ FakeFriend.find_by(id: 1) }
-
-      it "returns a FakeFriend" do
+      it 'returns a FakeFriend' do
         expect(user).to be_a FakeFriend
       end
 
-      it "returns the correct FakeFriend" do
-        expect(user.name).to eq("Visual Idiot")
+      it 'returns the correct FakeFriend' do
+        expect(user.name).to eq('Visual Idiot')
       end
     end
 
-    context "with valid input (by username)" do
-      let(:user){ FakeFriend.find_by(username: 'idiot') }
+    context 'with valid input (by username)' do
+      let(:user) { FakeFriend.find_by(username: 'idiot') }
 
-      it "returns a FakeFriend" do
+      it 'returns a FakeFriend' do
         expect(user).to be_a FakeFriend
       end
 
-      it "returns the correct FakeFriend" do
-        expect(user.name).to eq("Visual Idiot")
+      it 'returns the correct FakeFriend' do
+        expect(user.name).to eq('Visual Idiot')
       end
     end
 
-    context "with invalid input" do
-      describe "with an invalid key" do
+    context 'with invalid input' do
+      describe 'with an invalid key' do
         it { expect { FakeFriend.find_by(age: 50) }.to raise_error(ArgumentError) }
       end
-      describe "with an invalid id" do
-        it { expect { FakeFriend.find_by(id: 102) }.to raise_error(ArgumentError) }
+      describe 'with an invalid id' do
+        it { expect { FakeFriend.find_by(id: -1) }.to raise_error(ArgumentError) }
+        it { expect { FakeFriend.find_by(id: 101) }.to raise_error(ArgumentError) }
       end
-      describe "with an invalid username" do
-        it { expect { FakeFriend.find_by(username: "invalid_username") }.to raise_error(ArgumentError) }
+      describe 'with an invalid username' do
+        it { expect { FakeFriend.find_by(username: 'invalid_username') }.to raise_error(ArgumentError) }
       end
     end
   end

data/spec/spec_helper.rb

@@ -2,19 +2,17 @@ require 'fake_friends'
 require 'rspec/expectations'
 
 RSpec.configure do |config|
-
   config.expect_with :rspec do |c|
     c.syntax = :expect
   end
-
 end
 
 RSpec::Matchers.define :be_composed_of do |expected_type|
   match do |actual|
-    actual.all?{|u| u.is_a? expected_type}
+    actual.all? { |u| u.is_a? expected_type }
   end
 
-  failure_message_for_should do |actual|
+  failure_message do |actual|
     "expected #{actual.class} to be composed of #{expected_type}s"
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fake_friends
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Jake Romer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-19 00:00:00.000000000 Z
+date: 2015-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twitter
@@ -16,56 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.6.0
+        version: '5.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.6.0
+        version: '5.6'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: '10.1'
 description: A simple fake user generator
 email:
 - jacob.romer@icloud.com
@@ -88,7 +88,7 @@ files:
 - lib/fake_friends/version.rb
 - spec/fake_friends_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/jmromer/FakeFriends
+homepage: http://github.com/jkrmr/fake_friends
 licenses:
 - MIT
 metadata: {}
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Generates fake users with consistent attributes from public Twitter accounts
@@ -116,4 +116,3 @@ summary: Generates fake users with consistent attributes from public Twitter acc
 test_files:
 - spec/fake_friends_spec.rb
 - spec/spec_helper.rb
-has_rdoc: