bibliography 0.0.1

data/lib/bibliography/bic/subject.rb

@@ -0,0 +1,58 @@
+require 'csv'
+
+module Bibliography
+  module BIC
+    class Subject
+      Data = {}
+      CSV.foreach(File.join(File.dirname(__FILE__), 'data', 'subjects.csv')) do |line|
+        Data[line[0]] = {
+          code: line[0],
+          description: line[1]
+        }
+      end
+
+      # Class methods
+      def self.all
+        Data.keys.map {|s| Subject.new(s) }
+      end
+
+      # Instance methods
+
+      def initialize(code)
+        @data = Data[code] || {}
+      end
+
+      def code
+        @data[:code]
+      end
+
+      def description
+        @data[:description]
+      end
+
+      def valid?
+        !@data.empty?
+      end
+
+      def children?
+        !children.empty?
+      end
+
+      def children
+        return [] unless valid?
+        len = code.length
+        @children ||= Data.keys.select{ |key|
+          key.length > len && key[0..len-1] == code
+        }.map {|s| Subject.new(s) }
+      end
+
+      def parent?
+        !parent.nil? && parent.valid?
+      end
+
+      def parent
+        @parent ||= Subject.new(code[0]) if valid? && code.length > 1
+      end
+    end
+  end
+end

data/lib/bibliography/version.rb

@@ -0,0 +1,3 @@
+module Bibliography
+  VERSION = "0.0.1"
+end

data/spec/bibliography/bic/subject_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+describe Bibliography::BIC::Subject do
+  context "Class" do
+    describe ".all" do
+      it "is an array of all subjects" do
+        all = described_class.all
+        expect(all).to have(described_class::Data.length).items
+        expect(all.first.code).to eq("A")
+      end
+    end
+  end
+
+  context "Instance" do
+    context "valid" do
+      let(:subject) { Bibliography.subjects.new("AB") }
+
+      describe ".description" do
+        it "is a string" do
+          expect(subject.description).to eq("The arts: general issues")
+        end
+      end
+
+      describe ".code" do
+        it "is a string, matching the original code" do
+          expect(subject.code).to eq("AB")
+        end
+      end
+
+      describe ".valid?" do
+        it "is true" do
+          expect(subject.valid?).to be_true
+        end
+      end
+
+      describe ".children?" do
+        it "is true" do
+          expect(subject.children?).to be_true
+        end
+      end
+
+      describe ".children" do
+        it "returns an array of child subjects" do
+          expect(subject.children).to have(4).items
+        end
+      end
+
+      describe ".parent?" do
+        it "is true" do
+          expect(subject.parent?).to be_true
+        end
+      end
+
+      describe ".parent" do
+        it "returns the parent Subject" do
+          expect(subject.parent.code).to eq("A")
+        end
+      end
+    end
+
+    context "invalid" do
+      let(:subject) { Bibliography.subjects.new("invalid key") }
+
+      describe ".description" do
+        it "is nil" do
+          expect(subject.description).to be_nil
+        end
+      end
+
+      describe ".code" do
+        it "is a string matching the original code" do
+          expect(subject.code).to be_nil
+        end
+      end
+
+      describe ".valid?" do
+        it "is false" do
+          expect(subject.valid?).to be_false
+        end
+      end
+
+      describe ".children?" do
+        it "is false" do
+          expect(subject.children?).to be_false
+        end
+      end
+
+      describe ".children" do
+        it "is an empty array" do
+          expect(subject.children).to be_empty
+        end
+      end
+
+      describe ".parent?" do
+        it "is false" do
+          expect(subject.parent?).to be_false
+        end
+      end
+
+      describe ".parent" do
+        it "is nil" do
+          expect(subject.parent).to be_nil
+        end
+      end
+    end
+  end
+end

data/spec/bibliography_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Bibliography do
+  describe ".subjects" do
+    it "accepts a standards body name" do
+      expect(Bibliography.subjects(:bic)).to eq(Bibliography::BIC::Subject)
+    end
+
+    it "defaults to BIC::Subject" do
+      expect(Bibliography.subjects).to eq(Bibliography::BIC::Subject)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require 'rspec'
+require 'bibliography'
+
+RSpec.configure do |c|
+  c.order = "rand"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: bibliography
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mike Robinson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A library of useful tools for books and related standards
+email:
+- mike@studiolift.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bibliography.gemspec
+- lib/bibliography.rb
+- lib/bibliography/bic.rb
+- lib/bibliography/bic/data/subjects.csv
+- lib/bibliography/bic/subject.rb
+- lib/bibliography/version.rb
+- spec/bibliography/bic/subject_spec.rb
+- spec/bibliography_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/studiolift/bibliography
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.0
+signing_key: 
+specification_version: 4
+summary: Currently only offers an interface to BIC subjects
+test_files:
+- spec/bibliography/bic/subject_spec.rb
+- spec/bibliography_spec.rb
+- spec/spec_helper.rb