lcclasses 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 21d2c58127f8da9ef898fd8275f38adfd604360e
-  data.tar.gz: 64293c868662809bacdd5c684c024abfbced8da0
+SHA256:
+  metadata.gz: 49b2f5106b678c366efacf049369567d895f1e9869db97cdd476b06b02791adb
+  data.tar.gz: 8e5ac470b862993e636db8a97980b83e4773f6fdc3ce4af3bf0b8285291ef840
 SHA512:
-  metadata.gz: 91fd6596c61564b6749541e121e181d455b21a44c018c9dc1c41e639e22470c449e856bc8e8d879b10e61247bc3b05dbeb3c67e983514a1c8e115e4b29e79b53
-  data.tar.gz: 5d42ba82d6669f80a8f21ad35554a6e5d6f0eb8c6510367ddeecdeec34451333691997209138d786acf6547a8aec5386d24456269c3ffbed429ed611ac5c746a
+  metadata.gz: fa3770b6bb17e9002932fccd05eb5154fa4a2b8b79c60c47adf42a5484280021753a41da01a07612fed8257670f60863fc336a9afee384bc5cfd9b318f04e9ec
+  data.tar.gz: bdcda9e0a43f8e36257d16b2b5434eb5a6416eaeda132d7172f32c9a1f238ba9b171ac10df807b5ba3b9bcac062eb9bf01f9e953a6e9800154994315a3eccc6e

data/.document

@@ -1,4 +1,4 @@
-README.markdown
+README.md
 lib/**/*.rb
 bin/*
 features/**/*.feature

data/README.md

@@ -0,0 +1,76 @@
+# LCCLasses
+
+A Ruby gem that provides the Library of Congress Classification system main classes and subclasses along with some convenience methods.
+
+To install:
+
+```bash
+gem install lcclasses
+```
+
+## Usage
+
+To find a classification code:
+
+```ruby
+LCClasses.find_main_class_by_code("T")
+=> ["T", "Technology (General)"]
+LCClasses.find_subclass_by_code("AM")
+=> ["AM", "Museums. Collectors and collecting"]
+LCClasses.find_all_by_code("E")
+=> # returns the main "E" class and all subclasses in nested array
+LCClasses.main_classes
+=> # returns all main classes
+LCClasses.subclasses
+=> # returns all subclasses
+```
+
+The entire set of classes can be retrieved in 3 formats:
+
+```ruby
+LCClasses::CLASS_HASH
+=> # nested hash of classes and subclasses
+LCClasses.nested
+=> # nested array of classes and subclasses as LCClasses::LCClass objects
+LCClasses.flat
+=> # flat array of classes and subclasses as LCClasses::LCClass objects
+```
+
+The `CLASS_HASH` constant is in the following format (truncated example):
+
+```ruby
+{ "A" => {
+    :name => "General Works",
+    :subclasses => {
+      "AC" => { :name => "Collections; Series; Collected works" }
+    }
+  }
+}
+```
+
+Classes are returned as specialized LCClasses::Class arrays in the format `[code, name]`. In the case of nested LCClasses:LCClass objects, they are in the format `[main_class_code, main_class_name, [[subclass_code, subclass_name]]]`. These objects are normal arrays with the following methods added:
+
+```ruby
+@class = LCClasses.find_main_class_by_code("M")
+@class.code
+=> "M"
+@class.name
+=> "Music"
+@class.subclasses
+=> [["M", "Music"], ["ML", "Literature on music"], ["MT", "Instruction and study"]]
+```
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 William Melody. See LICENSE for details.

data/Rakefile

@@ -1,12 +1,12 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'bundler'
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts 'Run `bundle install` to install missing gems'
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 require 'rake'

data/lcclasses.gemspec

@@ -1,55 +1,37 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 
 Gem::Specification.new do |s|
-  s.name = %q{lcclasses}
-  s.version = '0.1.1'
-
-  s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
+  s.name = 'lcclasses'
+  s.version = '0.2.0'
+  s.licenses = ['MIT']
+  s.summary = 'Library of Congress Classification classes and subclasses.'
+  s.description = 'Library of Congress Classification classes and subclasses.'
   s.authors = ['William Melody']
-  s.date = %q{2016-05-09}
-  s.description = %q{Library of Congress Classification classes and subclasses}
-  s.email = %q{hi@williammelody.com}
+  s.email = 'hi@williammelody.com'
+  s.date = '2020-03-18'
   s.extra_rdoc_files = [
     'LICENSE',
-     'README.markdown'
+    'README.md'
   ]
   s.files = [
     '.document',
-     '.gitignore',
-     'LICENSE',
-     'README.markdown',
-     'Rakefile',
-     'lcclasses.gemspec',
-     'lib/lcclasses.rb',
-     'test/helper.rb',
-     'test/test_lcclasses.rb'
+    '.gitignore',
+    'LICENSE',
+    'README.md',
+    'Rakefile',
+    'lcclasses.gemspec',
+    'lib/lcclasses.rb',
+    'test/helper.rb',
+    'test/test_lcclasses.rb'
   ]
-  s.homepage = %q{http://github.com/alphabetum/lcclasses}
-  s.licenses = ['MIT']
-  s.rdoc_options = ['--charset=UTF-8']
-  s.require_paths = ['lib']
-  s.rubygems_version = %q{1.8.24}
-  s.summary = %q{Library of Congress Classification classes and subclasses}
   s.test_files = [
     'test/helper.rb',
-     'test/test_lcclasses.rb'
+    'test/test_lcclasses.rb'
   ]
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<minitest>, ['>= 0'])
-      s.add_development_dependency(%q<rdoc>, ['>= 0'])
-    else
-      s.add_dependency(%q<minitest>, ['>= 0'])
-      s.add_dependency(%q<rdoc>, ['>= 0'])
-    end
-  else
-    s.add_dependency(%q<minitest>, ['>= 0'])
-    s.add_dependency(%q<rdoc>, ['>= 0'])
-  end
+  s.homepage = 'http://github.com/xwmx/lcclasses'
+  s.require_paths = ['lib']
+  s.add_development_dependency('minitest',  '~> 5', '>= 0')
+  s.add_development_dependency('rdoc',      '~> 6', '>= 0')
+  s.add_development_dependency('rubocop',   '~> 0', '>= 0.49.0')
+  s.required_ruby_version = '>= 2.3'
 end

data/lib/lcclasses.rb

@@ -1,30 +1,36 @@
+# frozen_string_literal: true
+
 module LCClasses
   class LCClass < Array
     # Convert nested LCClasses::CLASS_HASH to nested array.
     def self.nest(hash)
       return self[] if hash.nil?
+
       hash.sort { |a, b| a[0] <=> b[0] }.inject(self[]) do |result, klass|
-        if klass[1][:subclasses]
-          result << self[klass[0], klass[1][:name], self.nest(klass[1][:subclasses])]
-        else
-          result << self[klass[0], klass[1][:name]]
-        end
+        result << if klass[1][:subclasses]
+                    self[klass[0], klass[1][:name], self.nest(klass[1][:subclasses])]
+                  else
+                    self[klass[0], klass[1][:name]]
+                  end
       end
     end
 
     # Convert nested LCClasses::CLASS_HASH to flat array.
     def self.flatten(hash)
       return self[] if hash.nil?
+
       hash.sort { |a, b| a[0] <=> b[0] }.inject(self[]) do |result, klass|
         result << self[klass[0], klass[1][:name]]
-        result += self.flatten(klass[1][:subclasses])
+        result + self.flatten(klass[1][:subclasses])
       end
     end
 
     # Return the subclasses of this class, if any.
     def subclasses
-      return unless i = LCClasses::CLASS_HASH[self[0]]
-      LCClasses::LCClass.nest(i[:subclasses])
+      class_data = LCClasses::CLASS_HASH[self[0]]
+      return if class_data.nil? || class_data.empty?
+
+      LCClasses::LCClass.nest(class_data[:subclasses])
     end
 
     # The class code.
@@ -364,7 +370,7 @@ module LCClasses
         'ZA'  => { :name => 'Information resources (General)' }
       }
     }
-  }
+  }.freeze
 
   # An array of main LC Classes.
   def self.main_classes
@@ -376,7 +382,7 @@ module LCClasses
   # An array of all LC Subclasses.
   def self.subclasses
     self.main_classes.inject([]) do |result, main_class|
-      result += main_class.subclasses
+      result + main_class.subclasses
     end
   end
 
@@ -406,7 +412,6 @@ module LCClasses
 
   # Find all main classes and subclass that match or start with a code or character.
   def self.find_all_by_code(code)
-    LCClasses.flat.select { |i| i[0] if (i[0] =~ /^#{code}[A-Z]?[A-Z]?/) }
+    LCClasses.flat.select { |i| i[0] if i[0] =~ /^#{code}[A-Z]?[A-Z]?/ }
   end
-
 end

data/test/helper.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler'
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts 'Run `bundle install` to install missing gems'
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 require 'minitest/autorun'

data/test/test_lcclasses.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 require 'helper'
 
 describe LCClasses do
-
   it 'should return main classes' do
     assert_equal 21, LCClasses.main_classes.length
   end
@@ -16,7 +17,7 @@ describe LCClasses do
 
   it 'should should return nested' do
     assert_equal 21, LCClasses.nested.length
-    assert_equal 223, LCClasses.nested.inject([]) { |r, m| r += m.subclasses }.length
+    assert_equal 223, LCClasses.nested.inject([]) { |a, e| a + e.subclasses }.length
   end
 
   it 'should find main class or subclass by code' do
@@ -38,13 +39,12 @@ describe LCClasses do
   end
 
   describe LCClasses::LCClass do
-
     def setup
       @hash = {
         'A' => {
           :name => 'General Works',
           :subclasses => {
-            'AC'   => { :name => 'Collections; Series; Collected works' }
+            'AC' => { :name => 'Collections; Series; Collected works' }
           }
         }
       }

metadata

@@ -1,19 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: lcclasses
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - William Melody
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-09 00:00:00.000000000 Z
+date: 2020-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
@@ -21,6 +24,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
@@ -28,6 +34,9 @@ dependencies:
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
@@ -35,52 +44,72 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
     - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-description: Library of Congress Classification classes and subclasses
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+description: Library of Congress Classification classes and subclasses.
 email: hi@williammelody.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE
-- README.markdown
+- README.md
 files:
 - ".document"
 - ".gitignore"
 - LICENSE
-- README.markdown
+- README.md
 - Rakefile
 - lcclasses.gemspec
 - lib/lcclasses.rb
 - test/helper.rb
 - test/test_lcclasses.rb
-homepage: http://github.com/alphabetum/lcclasses
+homepage: http://github.com/xwmx/lcclasses
 licenses:
 - MIT
 metadata: {}
 post_install_message: 
-rdoc_options:
-- "--charset=UTF-8"
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.2
 signing_key: 
-specification_version: 3
-summary: Library of Congress Classification classes and subclasses
+specification_version: 4
+summary: Library of Congress Classification classes and subclasses.
 test_files:
 - test/helper.rb
 - test/test_lcclasses.rb
-has_rdoc: 

data/README.markdown

@@ -1,66 +0,0 @@
-# LCCLasses
-
-A Ruby gem that provides the Library of Congress Classification system main classes and subclasses along with some convenience menthods.
-
-To install:
-
-    gem install lcclasses
-
-## Usage
-
-To find a classification code:
-
-    LCClasses.find_main_class_by_code("T")
-    => ["T", "Technology (General)"]
-    LCClasses.find_subclass_by_code("AM")
-    => ["AM", "Museums. Collectors and collecting"]
-    LCClasses.find_all_by_code("E")
-    => # returns the main "E" class and all subclasses in nested array
-    LCClasses.main_classes
-    => # returns all main classes
-    LCClasses.subclasses
-    => # returns all subclasses
-
-The entire set of classes can be retrieved in 3 formats:
-
-    LCClasses::CLASS_HASH
-    => # nested hash of classes and subclasses
-    LCClasses.nested
-    => # nested array of classes and subclasses as LCClasses::LCClass objects
-    LCClasses.flat
-    => # flat array of classes and subclasses as LCClasses::LCClass objects
-
-The CLASS\_HASH constant is in the following format (truncated example):
-
-    { "A" => {
-        :name => "General Works",
-        :subclasses => {
-          "AC" => { :name => "Collections; Series; Collected works" }
-        }
-      }
-    }
-
-Classes are returned as specialized LCClasses::Class arrays in the format `[code, name]`. In the case of nested LCClasses:LCClass objects, they are in the format `[main_class_code, main_class_name, [[subclass_code, subclass_name]]]`. These objects are normal arrays with the following methods added:
-
-    @class = LCClasses.find_main_class_by_code("M")
-    @class.code
-    => "M"
-    @class.name
-    => "Music"
-    @class.subclasses
-    => [["M", "Music"], ["ML", "Literature on music"], ["MT", "Instruction and study"]]
-
-## Note on Patches/Pull Requests
-
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but
-   bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-## Copyright
-
-Copyright (c) 2010 William Melody. See LICENSE for details.