backpack_tf 1.0.0.rc1 → 1.0.0.rc2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8673b991331c19d4f53c025859bce0ea112838c5
-  data.tar.gz: 34d35fa2c340a9e239c9525ff26e19768068dd41
+  metadata.gz: aad837f79d1e8158b7158d193b31dab2036d46ed
+  data.tar.gz: c03a3d108b72d82e15c0dd45ebde3bdf25f8d1bf
 SHA512:
-  metadata.gz: 12b37a2bf1e298ae661e00faa9f342be27f8e76dde8a853b767801e7b1c650eb45648fbe9de0c2d34246573ae8921500a90266bdcb2f6b3b8d49382b9cb01eae
-  data.tar.gz: 08bef1bcf70c9a98bd17f0bdcd23a3c1917816bdd297699b882e7d4d9d5e83160c7d8b6fb9372226eb8f775dedca208faecaba4fa13fde9c92d9bcea408c2b83
+  metadata.gz: 0046372f234d0756bbc9e5a7a7a3ea67c1ce3c062a6c4def4e1ca822a9efdba97f8cad10e0fb5f7e5ac5f2246cc58b893f36f15a385daefa59f461f6db28b4cc
+  data.tar.gz: a30f2616e7737bdfb24ba56142b97696bd8b8f70e3866001fe5d95e846409dfb208d18b77bddbb268971426b1f1762a3b2d193a40b4fffd1678b45d4123e280a

data/Gemfile

@@ -5,6 +5,6 @@ gem 'httparty', '~> 0.13.5'
 group :test do
   gem 'rspec', '~> 3.3.0'
   gem 'webmock', '~> 1.21.0'
-  gem 'simplecov', '~> 0.11.1', require: false
   gem 'rake', '~> 10.4.2', require: false
+  gem 'codeclimate-test-reporter', '~> 0.4.8', require: nil
 end

data/Gemfile.lock

@@ -2,6 +2,8 @@ GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.3.8)
+    codeclimate-test-reporter (0.4.8)
+      simplecov (>= 0.7.1, < 1.0.0)
     crack (0.4.2)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
@@ -39,10 +41,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  codeclimate-test-reporter (~> 0.4.8)
   httparty (~> 0.13.5)
   rake (~> 10.4.2)
   rspec (~> 3.3.0)
-  simplecov (~> 0.11.1)
   webmock (~> 1.21.0)
 
 BUNDLED WITH

data/README.md

@@ -1,6 +1,8 @@
 # backpack_tf
 
 [![Build Status](https://travis-ci.org/NerdDiffer/backpack_tf.svg?branch=master)](https://travis-ci.org/NerdDiffer/backpack_tf)
+[![Code Climate](https://codeclimate.com/github/NerdDiffer/backpack_tf/badges/gpa.svg)](https://codeclimate.com/github/NerdDiffer/backpack_tf)
+[![Test Coverage](https://codeclimate.com/github/NerdDiffer/backpack_tf/badges/coverage.svg)](https://codeclimate.com/github/NerdDiffer/backpack_tf/coverage)
 
 Backpack.tf is a website for the in-game economies of Team Fortress 2 and
 Dota 2. This gem is a wrapper for the backpack.tf [API](http://backpack.tf/api).

data/lib/backpack_tf/price/particle_effect.rb

@@ -2,26 +2,41 @@ module BackpackTF
   module Price
     # For ItemPrice objects with attached particle effects
     class ParticleEffect
+      RELATIVE_PATH_TO_ASSETS_FILE = '../assets/particle_effects.json'
+      KEY_TO_PARSE_IN_ASSETS_FILE  = 'attribute_controlled_attached_particles'
+
       class << self
         # @return [Hash] possible particle effects for an item
-        attr_reader :list
-      end
+        def list
+          @list ||= accumulate_assets
+        end
+
+        private
+
+        def accumulate_assets
+          effects = parse_assets_file
 
-      @key = 'attribute_controlled_attached_particles'
-      @file = './lib/backpack_tf/assets/particle_effects.json'
+          effects.each_with_object({}) do |effect, hash|
+            accumulate!(effect, hash)
+          end
+        end
 
-      def self.read_stored_effects_info
-        file = File.open(@file).read
-        effects = JSON.parse(file)[@key]
+        def parse_assets_file
+          file = File.open(absolute_path_to_assets_file).read
+          JSON.parse(file)[KEY_TO_PARSE_IN_ASSETS_FILE]
+        end
 
-        effects.each_with_object({}) do |effect, hash|
+        def absolute_path_to_assets_file
+          current_dirname = File.dirname(__FILE__)
+          File.expand_path(RELATIVE_PATH_TO_ASSETS_FILE, current_dirname)
+        end
+
+        def accumulate!(effect, hash)
           id = effect['id']
           name = effect['name']
           hash[id] = name
         end
       end
-
-      @list = read_stored_effects_info
     end
   end
 end

data/lib/backpack_tf/version.rb

@@ -1,3 +1,3 @@
 module BackpackTF
-  VERSION = '1.0.0.rc1'.freeze
+  VERSION = '1.0.0.rc2.1'.freeze
 end

data/spec/backpack_tf/price/particle_effect_spec.rb

@@ -1,23 +1,119 @@
 require 'spec_helper'
 
 describe BackpackTF::Price::ParticleEffect do
-  describe '::read_stored_effects_info' do
-    it 'creates a key value pair for each id & name' do
-      expect(described_class.read_stored_effects_info[17]).to eq 'Sunbeams'
-      expect(described_class.read_stored_effects_info[5]).to eq 'Holy Glow'
+  let(:parsed_assets) do
+    [
+      {
+        "system" => "foo",
+        "id" => 1,
+        "attach_to_rootbone" => true,
+        "name" => "Foo"
+      },
+      {
+        "system" => "bar",
+        "id" => 2,
+        "attach_to_rootbone" => false,
+        "name" => "Bar"
+      }
+    ]
+  end
+
+  describe '.list' do
+    context 'when @list is NOT nil' do
+      before(:each) do
+        described_class.class_eval { @list = :foo }
+      end
+      after(:each) do
+        described_class.class_eval { @list = nil }
+      end
+
+      it 'returns the value of @list' do
+        actual = described_class.list
+        expect(actual).to eq(:foo)
+      end
+      it 'does not call .accumulate_assets' do
+        expect(described_class).not_to receive(:accumulate_assets)
+        described_class.list
+      end
+    end
+
+    context 'when @list is nil' do
+      before(:each) do
+        allow(described_class).to receive(:accumulate_assets).and_return(:foo)
+        described_class.class_eval { @list = nil }
+      end
+      after(:each) do
+        described_class.list
+        described_class.class_eval { @list = nil }
+      end
+
+      it 'calls .accumulate_assets' do
+        expect(described_class).to receive(:accumulate_assets)
+      end
     end
-    it 'is nil if it cannot find that key' do
-      expect(described_class.read_stored_effects_info[nil]).to be_nil
+  end
+
+  describe '.accumulate_assets' do
+    before(:each) do
+      allow(described_class)
+        .to receive(:parse_assets_file)
+        .and_return(parsed_assets)
     end
 
-    context '@list' do
-      it 'same thing can be accessed through class variable' do
-        expect(described_class.list[17]).to eq 'Sunbeams'
-        expect(described_class.list[5]).to eq 'Holy Glow'
+    context 'reading a value at a known key' do
+      it 'can read the value at this key' do
+        actual = described_class.send(:accumulate_assets)[1]
+        expect(actual).to eq 'Foo'
       end
-      it 'is nil if it cannot find that key' do
-        expect(described_class.list[nil]).to be_nil
+      it 'can read the value at this key' do
+        actual = described_class.send(:accumulate_assets)[2]
+        expect(actual).to eq 'Bar'
       end
     end
+    context 'when it cannot find the requested key' do
+      it 'returns nil' do
+        actual = described_class.send(:accumulate_assets)[3]
+        expect(actual).to be_nil
+      end
+    end
+  end
+
+  describe '.parse_assets_file' do
+    let(:path_to_dummy_file) do
+      rel_path_to_dummy_file = '../../fixtures/particle_effects.json'
+      current_dirname = File.dirname(__FILE__)
+      File.expand_path(rel_path_to_dummy_file, current_dirname)
+    end
+
+    before(:each) do
+      allow(described_class)
+        .to receive(:absolute_path_to_assets_file)
+        .and_return(path_to_dummy_file)
+    end
+
+    it 'returns these results' do
+      expected = parsed_assets
+      actual = described_class.send(:parse_assets_file)
+      expect(actual).to eq expected
+    end
+  end
+
+  describe '.absolute_path_to_assets_file' do
+    it 'returns the absolute path to the assets file' do
+      actual = described_class.send(:absolute_path_to_assets_file)
+      expected = 'lib/backpack_tf/assets/particle_effects.json'
+      expect(actual).to match(/.*\/#{expected}/)
+    end
+  end
+
+  describe '.accumulate!' do
+    let(:effect) { { 'id' => 2, 'name' => 'Rad Effect' } }
+    let(:hash)   { { 1 => 'Cool Effect' } }
+
+    it 'mutates the hash, like so:' do
+      described_class.send(:accumulate!, effect, hash)
+      expected = { 1 => 'Cool Effect', 2 => 'Rad Effect' }
+      expect(hash).to eq expected
+    end
   end
 end

data/spec/fixtures/particle_effects.json

@@ -0,0 +1,16 @@
+{
+  "attribute_controlled_attached_particles": [
+    {
+      "system": "foo",
+      "id": 1,
+      "attach_to_rootbone": true,
+      "name": "Foo"
+    },
+    {
+      "system": "bar",
+      "id": 2,
+      "attach_to_rootbone": false,
+      "name": "Bar"
+    }
+  ]
+}

data/spec/spec_helper.rb

@@ -1,9 +1,14 @@
-require 'simplecov'
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
 SimpleCov.start
 
 require 'backpack_tf'
 require 'webmock/rspec'
 
+RSpec.configure do |config|
+  config.default_formatter = 'doc' if config.files_to_run.one?
+end
+
 def generate_fake_api_key
   hex_nums = %w(0 1 2 3 4 5 6 7 8 9 a b c d e f)
   key = ''
@@ -11,6 +16,8 @@ def generate_fake_api_key
   key
 end
 
+WebMock.disable_net_connect!(allow: 'codeclimate.com')
+
 # taken from httparty's spec dir
 # https://github.com/jnunemaker/httparty/blob/master/spec/spec_helper.rb
 def file_fixture(filename)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: backpack_tf
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.0.rc2.1
 platform: ruby
 authors:
 - Rafael Espinoza
@@ -134,6 +134,7 @@ files:
 - spec/fixtures/item_with_dual_craftability_tradability.json
 - spec/fixtures/item_with_unconventional_structure.json
 - spec/fixtures/market_prices.json
+- spec/fixtures/particle_effects.json
 - spec/fixtures/price_history.json
 - spec/fixtures/prices.json
 - spec/fixtures/special_items.json
@@ -161,9 +162,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: a wrapper for the backpack.tf API
 test_files: []
-has_rdoc: