astronomy 0.1.0

data/astronomy.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'astronomy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'astronomy'
+  spec.version       = Astronomy::VERSION
+  spec.authors       = ['Nick Aschenbach']
+  spec.email         = ['nick.aschenbach@gmail.com']
+  spec.summary       = %q{Get information using a simple interface about various celestial phenomena from Freebase. Search or browse the data.}
+  spec.description   = %q{Get the names, descriptions and image URLs for various categories including: Asterisms, Celestial Objects, Stars, Planets, Star Systems, Celestial object with coordinate systems, Asteroid Groups, Galaxies, Bodies with heliocentric orbits, Moons, Comets, Asteroids, Constellations, Nebulae, Natural satellites, Astronomical Discoveries, Galactic superclusters, Globular clusters, Supernovae, Galactic filaments, Meteor Showers. Also provides links to the full Freebase JSON data.}
+  spec.homepage      = 'https://github.com/nick-aschenbach/astronomy'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/astronomy.rb

@@ -0,0 +1,36 @@
+require 'astronomy/version'
+require 'yaml'
+
+module Astronomy
+  class Information
+    DATA_FILE = File.join(File.dirname(__dir__), 'assets', 'astronomy.yml')
+
+    attr_reader :data
+
+    def initialize
+      @data = YAML.load_file(DATA_FILE)
+    end
+
+    def categories
+      @data.keys
+    end
+
+    def topics(category)
+      @data[category]
+    end
+
+    def search(topic)
+      query = topic.downcase
+      results = []
+
+      @data.each do |category, array_of_topics|
+        array_of_topics.each do |topic|
+          results << topic and next if topic['name'].downcase.include?(query)
+          results << topic if topic['description'].downcase.include?(query)
+        end
+      end
+
+      results
+    end
+  end
+end

data/lib/astronomy/version.rb

@@ -0,0 +1,3 @@
+module Astronomy
+  VERSION = '0.1.0'
+end

data/spec/lib/astronomy_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe Astronomy::Information do
+  subject { Astronomy::Information.new }
+
+  it 'assigns Astronomy::Data::DATA_FILE' do
+    expect(Astronomy::Information::DATA_FILE).to_not be_nil
+  end
+
+  describe '.initialize' do
+    it 'loads the astronomical yaml data' do
+      expect(YAML).to receive(:load_file).with(Astronomy::Information::DATA_FILE)
+
+      subject
+    end
+
+    it 'stores this data in an instance variable' do
+      data = {foo: 'bar'}
+      allow(YAML).to receive(:load_file).with(Astronomy::Information::DATA_FILE).and_return(data)
+      expect(subject.instance_variable_get('@data')).to eq(data)
+
+      subject
+    end
+  end
+
+  describe '#data' do
+    it 'returns what is stored in the instance variable' do
+      data = {bar: 'baz'}
+      allow(YAML).to receive(:load_file).with(Astronomy::Information::DATA_FILE).and_return(data)
+
+
+      expect(subject.data).to eq(data)
+    end
+
+    it 'does not allow re-assignment of the astronomical data' do
+      allow(YAML).to receive(:load_file).with(Astronomy::Information::DATA_FILE).and_return({bar: 'baz'})
+
+      expect { subject.data = 'foobar' }.to raise_error(NoMethodError)
+    end
+  end
+
+  describe '#categories' do
+    let(:data) { {'Asterism' => [], 'Galaxy' => []} }
+
+    it 'returns a list of top level categories' do
+      allow(YAML).to receive(:load_file).with(Astronomy::Information::DATA_FILE).and_return(data)
+
+      expect(subject.categories).to match_array(['Asterism', 'Galaxy'])
+    end
+  end
+
+  describe '#topics' do
+    let(:data) { {'Topic A' => [1, 2, 3], 'Topic B' => %w[a b c]} }
+
+    it 'returns the topics for a specific category' do
+      allow(YAML).to receive(:load_file).with(Astronomy::Information::DATA_FILE).and_return(data)
+
+      expect(subject.topics('Topic A')).to match_array([1, 2, 3])
+    end
+
+    it 'returns nil when a category is invalid' do
+      allow(YAML).to receive(:load_file).with(Astronomy::Information::DATA_FILE).and_return(data)
+
+      expect(subject.topics('Invalid topic')).to be_nil
+    end
+  end
+
+  describe '#search' do
+    let(:data) { {
+      'Asterism' =>
+        [{'name' => 'Apple', 'description' => 'A lovely fruit'},
+         {'name' => 'Squash', 'description' => 'A great sport or fruit'},
+         {'name' => 'Squish', 'description' => 'A soft wet sound'}]
+    } }
+
+    it 'returns an array of topics with names that match the query' do
+      allow(YAML).to receive(:load_file).with(Astronomy::Information::DATA_FILE).and_return(data)
+
+      expect(subject.search('sq')).to match_array([{'name' => 'Squash', 'description' => 'A great sport or fruit'},
+                                                   {'name' => 'Squish', 'description' => 'A soft wet sound'}])
+    end
+
+    it 'returns an array of topics with descriptions that match the query' do
+      allow(YAML).to receive(:load_file).with(Astronomy::Information::DATA_FILE).and_return(data)
+
+      expect(subject.search('fruit')).to match_array([{'name' => 'Apple', 'description' => 'A lovely fruit'},
+                                                      {'name' => 'Squash', 'description' => 'A great sport or fruit'}])
+    end
+
+    it 'returns a topic once when both the name and description match' do
+      allow(YAML).to receive(:load_file).with(Astronomy::Information::DATA_FILE).and_return(data)
+
+      expect(subject.search('A')).to match_array(data['Asterism'])
+    end
+
+    it 'returns an empty array when the query does not match anything' do
+      allow(YAML).to receive(:load_file).with(Astronomy::Information::DATA_FILE).and_return(data)
+
+      expect(subject.search('zx')).to match_array([])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'astronomy'

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: astronomy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Aschenbach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 'Get the names, descriptions and image URLs for various categories including:
+  Asterisms, Celestial Objects, Stars, Planets, Star Systems, Celestial object with
+  coordinate systems, Asteroid Groups, Galaxies, Bodies with heliocentric orbits,
+  Moons, Comets, Asteroids, Constellations, Nebulae, Natural satellites, Astronomical
+  Discoveries, Galactic superclusters, Globular clusters, Supernovae, Galactic filaments,
+  Meteor Showers. Also provides links to the full Freebase JSON data.'
+email:
+- nick.aschenbach@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- assets/astronomy.yml
+- astronomy.gemspec
+- lib/astronomy.rb
+- lib/astronomy/version.rb
+- spec/lib/astronomy_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nick-aschenbach/astronomy
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Get information using a simple interface about various celestial phenomena
+  from Freebase. Search or browse the data.
+test_files:
+- spec/lib/astronomy_spec.rb
+- spec/spec_helper.rb