dinosaur_catalog 2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2e8c3738a3da8042fa643bcbdd469f8c2d3f4567
+  data.tar.gz: f5d7b0201d267965829d3ae474b7a0da1651aee3
+SHA512:
+  metadata.gz: 7021420ac33bea265830a6dcb236700d44b1beb9ea85fe67bccba97cd399a376f3d4958d8fbcf5de96ed3bdba86e0d29f8ff58a9cb680c20c14cc8cbed6cd8cc
+  data.tar.gz: 1575cb4e41f70234de9dcf037c1018a70ab3297e6d931e930ae9e87d8725210d69a66de320a6c63c0bc317e9663be6addd9fef32e247a119222486e02a5c23ae

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) <year> <copyright holders>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README

@@ -0,0 +1,28 @@
+## Dinosaur Catalog
+
+It may not be immediately evident, but I am a huge fan of dinosaurs. They're huge and dangerous and have cool names like Giganotosaurus (not to be confused with Gigantosaurus).
+
+...
+
+Anyway. I need to catalog some dinosaurs for my newest project, DinoDex. I've got a CSV file for the dinosaur facts, and I need the code to read all the dinosaur facts and do some basic manipulations with the data.
+
+### Requirements
+
+Go check out the CSVs and come back. Done? Cool, I've just got a few features I need:
+
+1. I loaded my favorite dinosaurs into a CSV file you'll need to parse. I don't know a lot about African Dinosaurs though, so I downloaded one from The Pirate Bay. It isn't formatted as well as mine, but please try to parse it anyway.
+2. I have friends who ask me a lot of questions about dinosaurs (I'm kind of a big deal). Please make sure the dinodex is able to answer these things for me:
+    * Grab all the dinosaurs that were bipeds.
+    * Grab all the dinosaurs that were carnivores (fish and insects count).
+    * Grab dinosaurs for specific periods (no need to differentiate between Early and Late Cretaceous, btw).
+    * Grab only big (> 2 tons) or small dinosaurs.
+    * Just to be sure, I'd love to be able to combine criteria at will, even better if I can chain filter calls together.
+3. For a given dino, I'd like to be able to print all the known facts about that dinosaur. If there are facts missing, please don't print empty values, just skip that heading. Make sure to print Early / Late etc for the periods.
+4. Also, I'll probably want to print all the dinosaurs in a given collection (after filtering, etc).
+
+#### Extra Credit
+
+1. I would love to have a way to do (and chain) generic search by parameters. I can pass in a hash, and I'd like to get the proper list of dinos back out.
+2. CSV isn't may favorite format in the world. Can you implement a JSON export feature?
+
+Happy Hunting. (Giganotosaurus was the largest hunting dinosaur, at 46 feet long and up to 8 tons! Suh-weet.)

data/bin/african_dinosaur_export.csv

@@ -0,0 +1,8 @@
+Genus,Period,Carnivore,Weight,Walking
+Abrictosaurus,Jurassic,No,100,Biped
+Afrovenator,Jurassic,Yes,,Biped
+Carcharodontosaurus,Albian,Yes,3000,Biped
+Giraffatitan,Jurassic,No,6600,Quadruped
+Paralititan,Cretaceous,No,120000,Quadruped
+Suchomimus,Cretaceous,Yes,10400,Biped
+Melanorosaurus,Triassic,No,2400,Quadruped

data/bin/dinodex.csv

@@ -0,0 +1,10 @@
+NAME,PERIOD,CONTINENT,DIET,WEIGHT_IN_LBS,WALKING,DESCRIPTION
+Albertosaurus,Late Cretaceous,North America,Carnivore,2000,Biped,Like a T-Rex but smaller.
+Albertonykus,Early Cretaceous,North America,Insectivore,,Biped,Earliest known Alvarezsaurid.
+Baryonyx,Early Cretaceous,Europe,Piscivore,6000,Biped,One of the only known dinosaurs with a fish-only diet.
+Deinonychus,Early Cretaceous,North America,Carnivore,150,Biped,
+Diplocaulus,Late Permian,North America,Carnivore,,Quadruped,They actually had fins on the side of their body.
+Megalosaurus,Jurassic,Europe,Carnivore,2200,Biped,Originally thought to be a Quadruped. First dinosaur to be named.
+Giganotosaurus,Late Cretaceous,South America,Carnivore,30420,Biped,Largest hunter and also the coolest ever.
+Quetzalcoatlus,Late Cretaceous,North America,Carnivore,440,Quadruped,Largest known flying animal of all time.
+Yangchuanosaurus,Oxfordian,Asia,Carnivore,7200,Biped,

data/bin/dinosaur_catalog

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/dinosaur_catalog/catalog'
+require_relative '../lib/dinosaur_catalog/app'
+
+app = DinosaurCatalog::App.new("dinosaur_catalog")
+
+USER_FILE_IMPORT = %Q%\nPlease enter the filename of the CSV to import\n\n\
+Enter 'quit' or 'exit' to leave the program.\n\n>> %
+
+if ARGV.size == 1
+  csv_file = ARGV.shift
+  app.launch_app!(File.join(File.dirname(__FILE__), csv_file))
+else
+  print USER_FILE_IMPORT
+  user_file = gets.chomp
+  app.create_app(File.join(File.dirname(__FILE__), user_file))
+end

data/lib/dinosaur_catalog/app.rb

@@ -0,0 +1,75 @@
+require 'pry'
+require 'active_support'
+require 'active_support/core_ext'
+require 'active_support/inflector/inflections'
+require_relative 'display'
+require_relative 'json_export'
+require_relative 'csv_modifier'
+require_relative 'user_prompts'
+require_relative 'user_processing'
+
+module DinosaurCatalog
+  class App
+    include CsvModifier
+    include Filters
+    include Display
+    include JsonExport
+    include UserProcessing
+
+    EXIT_TERMS = ['quit', 'exit']
+
+    def initialize(name)
+      @app_name = name
+    end
+
+    def create_app(file)
+      if EXIT_TERMS.include?(file)
+        puts "\n\nExiting.\n\n"
+        exit!
+      else
+        puts "\nFile Found!\n"
+        launch_app!(file)
+      end
+    end
+
+    def launch_app!(csv_filename=nil)
+      @csv_filename = csv_filename
+      new_csv_file = normalize_csv_file(csv_filename)
+      @catalog = create_catalog(new_csv_file)
+      obtain_user_filters
+    end
+
+    def create_catalog(filepath)
+      @catalog = Catalog.new(filepath)
+    end
+
+    def perform_search(input)
+      exit! if EXIT_TERMS.include? input
+      search_terms = get_user_search_terms(input)
+      search_dinosaurs(search_terms)
+    end
+
+    def search_dinosaurs(terms)
+      @filtered_dinosaurs = nil
+      @filtered_dinosaurs = filter_dinosaur_results(@catalog, terms)
+      puts "\nYour search resulted in #{@filtered_dinosaurs.size} dinosaurs:"
+      print_search_summary(@filtered_dinosaurs)
+      user_processing
+    end
+
+    def filter_dinosaur_results(catalog, filters)
+      filtered_dinosaur_listings = catalog.dinosaurs
+      filters.each do |search_type, criteria|
+        filter_function = "filter_#{search_type}".to_sym
+        filtered_dinosaur_listings = Catalog.from_array(filtered_dinosaur_listings).send(filter_function, criteria)
+      end
+      filtered_dinosaur_listings
+    end
+
+    def print_search_summary(search_results)
+      puts "\n"
+      search_results.each { |dinosaur| puts "#{dinosaur.name}" }
+      puts "\n"
+    end
+  end
+end

data/lib/dinosaur_catalog/catalog.rb

@@ -0,0 +1,32 @@
+require_relative 'dinosaur'
+require_relative 'filters'
+
+module DinosaurCatalog
+  class Catalog
+    include Filters
+
+    attr_reader :dinosaurs
+
+    def initialize(csv_object=nil)
+      #@path = path
+      @dinosaurs = []
+      build_catalog_entries(csv_object) unless csv_object.nil?
+    end
+
+    def build_catalog_entries(csv_file)
+      CSV.parse(csv_file, headers: true, header_converters: :symbol).each do |data|
+        @dinosaurs << create_dinosaur_entry(data[:name], data)
+      end
+    end
+
+    def create_dinosaur_entry(name, attributes)
+      Dinosaur.new(name, attributes)
+    end
+
+    def self.from_array(array)
+      catalog = Catalog.new
+      catalog.instance_variable_set(:@dinosaurs, array)
+      catalog
+    end
+  end
+end

data/lib/dinosaur_catalog/csv_modifier.rb

@@ -0,0 +1,47 @@
+require 'csv'
+
+module DinosaurCatalog
+  module CsvModifier
+    NORMALIZED_CSV_FILENAME = "normalized_csv_file.csv"
+
+    ALIAS_TABLE = {
+      'Genus' => 'Name',
+      'Carnivore' => 'Diet',
+      'Weight' => 'Weight_in_lbs',
+    }
+
+    def normalize_csv_file(filename)
+      new_header_names = replace_header_with_alias(filename)
+      normalize_csv_body(filename, new_header_names)
+    end
+
+    def normalize_csv_body(old_csv_file, header_row)
+      new_headers = replace_header_with_alias(old_csv_file)
+      #CSV.open(NORMALIZED_CSV_FILENAME, 'w') do |csv|
+      new_csv_file = CSV.generate do |csv|
+        csv << header_row
+        CSV.read(old_csv_file, headers: true).each do |row|
+          row['Carnivore'] = 'Carnivore' if row['Carnivore'] == 'Yes'
+          row['Carnivore'] = 'No' if row['Carnivore'] == 'No'
+          csv.puts row
+        end
+      end
+      new_csv_file
+    end
+
+    def replace_header_with_alias(csv_file)
+      header_row = CSV.read(csv_file, headers: true).headers
+      build_table_body(header_row)
+    end
+
+    def build_table_body(header)
+      header.inject([]) do |new_header, column_name|
+        if ALIAS_TABLE[column_name]
+          new_header << ALIAS_TABLE[column_name]
+        else
+          new_header << column_name
+        end
+      end
+    end
+  end
+end

data/lib/dinosaur_catalog/dinosaur.rb

@@ -0,0 +1,36 @@
+module DinosaurCatalog
+  class Dinosaur
+    BIG_DINOSAUR_LBS = 2
+    POUNDS_PER_TON = 2000.0
+
+    attr_reader :name, :period, :continent, :diet, :weight_in_lbs, :walking, :description
+
+    def initialize(name, options = {})
+      @name = name
+      @period = options[:period]
+      @continent = options[:continent]
+      @diet = options[:diet]
+      @weight_in_lbs = options[:weight_in_lbs]
+      @walking = options[:walking]
+      @description = options[:description]
+    end
+
+    def big?
+      weight_in_tons > BIG_DINOSAUR_LBS
+    end
+
+    def small?
+      weight_in_tons > 0 && weight_in_tons <= BIG_DINOSAUR_LBS
+    end
+
+    def weight_in_tons
+      @weight_in_lbs.to_i / POUNDS_PER_TON
+    end
+
+    def to_hash
+      hash = {}
+      instance_variables.each {|var| hash[var.to_s.delete("@")] = instance_variable_get(var) }
+      hash
+    end
+  end
+end

data/lib/dinosaur_catalog/display.rb

@@ -0,0 +1,60 @@
+module DinosaurCatalog
+  module Display
+    PADDING = 20
+
+    HEADER_NAMES = ["Name", "Period", "Continent", "Diet", "Weight (lbs)", "Walking", "Description"]
+
+    def print_dinosaur_set(set)
+      print_summary_header
+      set.each do |entry|
+        print_attribute(entry.name, PADDING)
+        print_attribute(entry.period, PADDING)
+        print_attribute(entry.continent, PADDING)
+        print_attribute(entry.diet, PADDING)
+        print_attribute(entry.weight_in_lbs, PADDING)
+        print_attribute(entry.walking, PADDING)
+        print_attribute(entry.description, PADDING)
+        puts
+      end
+    end
+
+    def print_dinosaur_instance(set, name)
+      entry = set.detect { |dinosaur| dinosaur.name.downcase =~ /#{name}/ }
+      if entry
+        puts "\nBelow is information on the dinosaur you entered:\n\n"
+        print "Name".center(PADDING) if entry.name
+        print "Period".center(PADDING) if entry.period
+        print "Continent".center(PADDING) if entry.continent
+        print "Diet".center(PADDING) if entry.diet
+        print "Weight (lbs)".center(PADDING) if entry.weight_in_lbs
+        print "Walking".center(PADDING) if entry.walking
+        print "Description".center(PADDING) if entry.description
+        puts ''
+        print_attribute(entry.name, PADDING) if entry.name
+        print_attribute(entry.period, PADDING) if entry.period
+        print_attribute(entry.continent, PADDING) if entry.continent
+        print_attribute(entry.diet, PADDING) if entry.diet
+        print_attribute(entry.weight_in_lbs, PADDING) if entry.weight_in_lbs
+        print_attribute(entry.walking, PADDING) if entry.walking
+        print_attribute(entry.description, PADDING) if entry.description
+        puts
+      else
+        puts "\nSorry, but I did not recognize that dinosaur name.\n"
+      end
+    end
+
+    def print_attribute(attribute, padding)
+      if attribute
+        print attribute.center(padding)
+      else
+        print "---".center(padding)
+      end
+    end
+
+    def print_summary_header
+      puts "\n\n"
+      HEADER_NAMES.each { |header| print header.center(PADDING) }
+      puts ''
+    end
+  end
+end

data/lib/dinosaur_catalog/filters.rb

@@ -0,0 +1,23 @@
+module DinosaurCatalog
+  module Filters
+    def filter_bipeds(biped_terms)
+      dinosaurs.select { |dinosaur| biped_terms.include?(dinosaur.walking.downcase) }
+    end
+
+    def filter_carnivores(carnivore_terms)
+      dinosaurs.select { |dinosaur| carnivore_terms.include?(dinosaur.diet.downcase) }
+    end
+
+    def filter_periods(period_terms)
+      periods_in_regex_array = Regexp.union(period_terms)
+      dinosaurs.select { |dinosaur| dinosaur.period.downcase.match(periods_in_regex_array) }
+    end
+
+    def filter_sizes(size_terms)
+      case
+        when size_terms.include?('big') then dinosaurs.select(&:big?)
+        when size_terms.include?('small') then dinosaurs.select(&:small?)
+      end
+    end
+  end
+end

data/lib/dinosaur_catalog/json_export.rb

@@ -0,0 +1,12 @@
+module DinosaurCatalog
+  module JsonExport
+    def convert_to_json(ruby_object)
+      array_of_objects = convert_object_to_array(ruby_object)
+      File.open("json_export.json", "w") { |f| f.puts JSON.generate(array_of_objects) }
+    end
+
+    def convert_object_to_array(object)
+      object.inject([]) { |array, attribute| array << attribute.to_hash }
+    end
+  end
+end

data/lib/dinosaur_catalog/user_processing.rb

@@ -0,0 +1,63 @@
+module DinosaurCatalog
+  module UserProcessing
+    SEARCH_REGEX = {
+      bipeds: /biped/,
+      carnivores: /carnivore|insectivore|piscivore/,
+      periods: /cretaceous|permian|jurassic|oxfordian|albian|triassic/,
+      sizes: /big|small/,
+    }
+
+    EXIT_TERMS = ['quit', 'exit']
+
+    def obtain_user_filters
+      print UserPrompts::USER_SEARCH_PROMPT
+      print '> '
+      user_input = gets.chomp.downcase
+      puts
+      perform_search(user_input)
+    end
+
+    def get_user_search_terms(phrase)
+      search_terms = {}
+      SEARCH_REGEX.each do |term, regex|
+        search_terms[term] = phrase.scan(regex) unless phrase.scan(regex).empty? #  use inject?
+      end
+      search_terms
+    end
+
+    def user_processing
+      print UserPrompts::USER_PROCESSING_PROMPT
+      print '> '
+      user_input = gets.chomp.downcase
+      user_actions(user_input)
+    end
+
+    def user_actions(user_input)
+      exit! if EXIT_TERMS.include? user_input
+      return print_results if user_input == 'print'
+      return new_search if user_input == 'search'
+      return json if user_input == 'json'
+      return search_dinosaur(user_input)
+    end
+
+    def print_results
+      print_dinosaur_set(@filtered_dinosaurs)
+      user_processing
+    end
+
+    def new_search
+      launch_app!(@csv_filename)
+    end
+
+    def json
+      convert_to_json(@filtered_dinosaurs)
+      puts "\nYour JSON file has been saved as json_export.json in the main directory."
+      user_processing
+    end
+
+    def search_dinosaur(input)
+      print_dinosaur_instance(@filtered_dinosaurs, input)
+      user_processing
+    end
+  end
+end

data/lib/dinosaur_catalog/user_prompts.rb

@@ -0,0 +1,23 @@
+module DinosaurCatalog
+  module UserPrompts
+    USER_SEARCH_PROMPT = <<-HEREDOC.strip_heredoc
+
+        What would you like to do?\n
+        You can enter a phrase that includes the keywords you want to filter the dinosaur catalog by.\n
+        For example:\n
+          Carnivores Big Triassic Bipeds\n
+        Which will return all dinosaurs that meet the four criteria.\n
+        Otherwise, to exit this program, enter 'quit'.\n
+        HEREDOC
+
+      USER_PROCESSING_PROMPT = <<-HEREDOC.strip_heredoc
+
+        You may perform the following action on the search results\n
+          Enter 'Print' to list the dinosaurs that met your search criteria.\n
+          Enter the dinosaur's name to list information on an individual dinosaur.\n
+          Enter 'json' to export the search results as a JSON file.\n
+          Enter 'Search' to perform another search.\n
+        Otherwise, to exit this program, enter 'quit'.\n
+        HEREDOC
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: dinosaur_catalog
+version: !ruby/object:Gem::Version
+  version: '2.0'
+platform: ruby
+authors:
+- Paul Haddad
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-07 00:00:00.000000000 Z
+dependencies: []
+description: |
+  ## Dinosaur Catalog
+
+  It may not be immediately evident, but I am a huge fan of dinosaurs. They're huge and dangerous and have cool names like Giganotosaurus (not to be confused with Gigantosaurus).
+
+  ...
+
+  Anyway. I need to catalog some dinosaurs for my newest project, DinoDex. I've got a CSV file for the dinosaur facts, and I need the code to read all the dinosaur facts and do some basic manipulations with the data.
+
+  ### Requirements
+
+  Go check out the CSVs and come back. Done? Cool, I've just got a few features I need:
+
+  1. I loaded my favorite dinosaurs into a CSV file you'll need to parse. I don't know a lot about African Dinosaurs though, so I downloaded one from The Pirate Bay. It isn't formatted as well as mine, but please try to parse it anyway.
+  2. I have friends who ask me a lot of questions about dinosaurs (I'm kind of a big deal). Please make sure the dinodex is able to answer these things for me:
+      * Grab all the dinosaurs that were bipeds.
+      * Grab all the dinosaurs that were carnivores (fish and insects count).
+      * Grab dinosaurs for specific periods (no need to differentiate between Early and Late Cretaceous, btw).
+      * Grab only big (> 2 tons) or small dinosaurs.
+      * Just to be sure, I'd love to be able to combine criteria at will, even better if I can chain filter calls together.
+  3. For a given dino, I'd like to be able to print all the known facts about that dinosaur. If there are facts missing, please don't print empty values, just skip that heading. Make sure to print Early / Late etc for the periods.
+  4. Also, I'll probably want to print all the dinosaurs in a given collection (after filtering, etc).
+
+  #### Extra Credit
+
+  1. I would love to have a way to do (and chain) generic search by parameters. I can pass in a hash, and I'd like to get the proper list of dinos back out.
+  2. CSV isn't may favorite format in the world. Can you implement a JSON export feature?
+
+  Happy Hunting. (Giganotosaurus was the largest hunting dinosaur, at 46 feet long and up to 8 tons! Suh-weet.)
+email: paul.g.haddad@gmail.com
+executables:
+- dinosaur_catalog
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README
+- bin/african_dinosaur_export.csv
+- bin/dinodex.csv
+- bin/dinosaur_catalog
+- lib/dinosaur_catalog/app.rb
+- lib/dinosaur_catalog/catalog.rb
+- lib/dinosaur_catalog/csv_modifier.rb
+- lib/dinosaur_catalog/dinosaur.rb
+- lib/dinosaur_catalog/display.rb
+- lib/dinosaur_catalog/filters.rb
+- lib/dinosaur_catalog/json_export.rb
+- lib/dinosaur_catalog/user_processing.rb
+- lib/dinosaur_catalog/user_prompts.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby program for the Dino Catalog Exercise as part of the Level Up Program.
+test_files: []
+has_rdoc: