franklin 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 609ae9a3826ac3f2c416a293f8c714420b904646
-  data.tar.gz: 639c32c3fe2346aa6e358a237d52bcfaef8ad4b0
+  metadata.gz: 4b28166199fc01ed59e8ef8f918d6e5b404ac943
+  data.tar.gz: 0043b45827969a4a40cf03bd5e4a1a32643e6d62
 SHA512:
-  metadata.gz: 7a7963ae9f09b9bb14aeaab91c76d2e0a5940849ad9d8e3622a2345e8391fd96b249b30d8706616e08bb1bddfc47a97f63514d0ebe8abbf73d4d57e5f3b3b09b
-  data.tar.gz: 49c25f0bfe6b9eb2604a2d417b5a755b9f4945e8cb2ac4dfb6537b4917fedd83f985a692075d56c1e912f290963807d0add70362d22b084d75a4dc395fdba4b6
+  metadata.gz: 65f0a1ff825f1a9f6fd1504cad211f6a4645076de76076b3cc952bd070e540167a9b88fea154d7f8c22738c797db2ab0f799af671a89bffd5765bebdb094e82c
+  data.tar.gz: 588d7eb305be7e05e7bb8356172a0174f1d900eb79316dc30c8ff1a24a1ff4f0ea2cce43bdcfa029357b17ab250b407851d4adfef4cebc1eedc78b376f4e08c6

data/.rubocop.yml

@@ -0,0 +1,36 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+
+Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Style/BlockDelimiters:
+  EnforcedStyle: semantic
+  FunctionalMethods:
+     - before
+     - after
+     - subject
+     - subject!
+     - let
+     - let!
+
+  AutoCorrect: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/AndOr:
+  AutoCorrect: false
+
+Style/SignalException:
+  EnforcedStyle: semantic
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/CHANGELOG.md

@@ -1,2 +1,5 @@
+# 0.4.0
+- Use strings for keys in YAML configuration file, instead of non-standard symbols
+
 # 0.3.0
 - Accomodate changes in OverDrive. Public libraries now have a new format

data/README.md

@@ -14,12 +14,12 @@ Franklin needs to be configured with information about the Overdrive libraries i
 
 ``` yml
 ---
-:libraries:
-  - :name: San Francisco Public Library
-    :url: http://sfpl.lib.overdrive.com
-  - :name: San Diego Public Library
-    :url: http://sdpl.lib.overdrive.com
-:default_type: eBook # Optional, will show all types if not set.
+libraries:
+  - name: San Francisco Public Library
+    url: http://sfpl.lib.overdrive.com
+  - name: San Diego Public Library
+    url: http://sdpl.lib.overdrive.com
+default_type: eBook # Optional, will show all types if not set.
 ```
 
 There needs to be a minimum of one library, but there is no maximum. The `name` can be anything and will be included when the search results are presented. The `url` should point to the domain of the public library. It can be obtained by visiting Overdrive's site for each library, copying the url and stripping everything after the domain name.

data/exe/franklin

@@ -35,11 +35,11 @@ rescue Errno::ENOENT
   Oops! It looks like you have not configured franklin
   Please add a configuration file in $HOME/.franklin that looks like this:
   ---
-  :libraries:
-    - :name: San Francisco Public Library
-      :url: http://sfpl.lib.overdrive.com
-    - :name: San Diego Public Library
-      :url: http://sdpl.lib.overdrive.com
-  :default_type: eBook # Optional, leave empty to search for all types
+  libraries:
+    - name: San Francisco Public Library
+      url: http://sfpl.lib.overdrive.com
+    - name: San Diego Public Library
+      url: http://sdpl.lib.overdrive.com
+  default_type: eBook # Optional, leave empty to search for all types
   ERROR
 end

data/franklin.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry", "~> 0.10"
   spec.add_development_dependency "vcr", "~> 3.0"
   spec.add_development_dependency "webmock", "~> 1.22"
+  spec.add_development_dependency "rubocop", "0.46"
 end

data/lib/franklin/availability_description.rb

@@ -11,7 +11,7 @@ module Franklin
     end
 
     def available?
-      available_copies > 0
+      available_copies.positive?
     end
 
     def copies_per_person
@@ -19,7 +19,7 @@ module Franklin
     end
 
     def wait_list_size?
-      wait_list_size > 0
+      wait_list_size.positive?
     end
   end
 end

data/lib/franklin/config.rb

@@ -7,10 +7,10 @@ module Franklin
     attr_reader :libraries, :default_type
 
     def initialize(data)
-      @libraries = data.fetch(:libraries).map { |library|
-        Library.new(library.fetch(:name), library.fetch(:url))
+      @libraries = data.fetch("libraries").map { |library|
+        Library.new(library.fetch("name"), library.fetch("url"))
       }
-      @default_type = data[:default_type]
+      @default_type = data["default_type"]
     end
 
     class << self

data/lib/franklin/type_filter.rb

@@ -6,7 +6,7 @@ module Franklin
 
     def perform(results)
       return results unless type
-      results.dup.keep_if { |item, _availability| item.format.casecmp(type) == 0 }
+      results.dup.keep_if { |item, _availability| item.format.casecmp(type).zero? }
     end
 
     private

data/lib/franklin/version.rb

@@ -1,3 +1,3 @@
 module Franklin
-  VERSION = "0.3.0".freeze
+  VERSION = "0.4.0".freeze
 end

data/lib/franklin.rb

@@ -5,11 +5,11 @@ require "franklin/type_filter"
 require "franklin/console_report"
 
 module Franklin
-  def run(search_terms, opts)
-    config = Config.load_from_file(opts[:config_path])
+  def run(search_terms, config_path: nil, type: nil, out:)
+    config = Config.load_from_file(config_path)
     results = ThreadedSearch.new(config.libraries).perform(search_terms)
-    filtered_results = TypeFilter.new(opts[:type] || config.default_type).perform(results)
-    ConsoleReport.new(search_terms, filtered_results).print_to_out(opts[:out])
+    filtered_results = TypeFilter.new(type || config.default_type).perform(results)
+    ConsoleReport.new(search_terms, filtered_results).print_to_out(out)
   end
 
   module_function :run

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: franklin
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ylan Segal
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-16 00:00:00.000000000 Z
+date: 2016-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.22'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.46'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.46'
 description: 
 email:
 - ylan@segal-family.com
@@ -117,6 +131,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile