pony_breeds 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3380d35701b6f0b5ecf9749d6c1488b8f9a0866e2559cccc3b432b45a24e260e
-  data.tar.gz: d54b0fb26ef192f1bad851f5dfbc55a1f5ddf0a52977e80aea8a101437899582
+  metadata.gz: 21d17b0862a60ac023d882dfeec2e0dab387b37df44166abb947561ab1d3dc19
+  data.tar.gz: 55725eddb2561837c70c01433e58ff2899220eda94b35e9e99ed36596545cb35
 SHA512:
-  metadata.gz: d31c5cada0fbe8f194fe1f5a4363ab8491b9acd485b88d79da028687d35f2628cadc9339203189ce1a2e6435bedbc8fa42a27dff0632088c6f5aa2922b59a40e
-  data.tar.gz: 667f8993adaf68c402454d13485adcb50f93d4e1727e0ce343d6c94d5b82a9c5a66238a2881dbf1502bff8623e235f0b7205fb724103430e314b59d1ea4e3ef8
+  metadata.gz: ec1b0526edc24a1459b0ec931371bdfd80ff3911da40678c4c70b11c21c6ac2660b330a256705ba1431919fea26d97afef00a7b4aa55770db27e5c0ca508d2cd
+  data.tar.gz: 98f956737588f1ea972815545ee82c8bd28219fcdea7e8edceec06a6c02787dd133eb1a9f6acb26ccb94c2093bb1c3906eea6173b2b6be5f5557e8587a699cac

data/.rspec

@@ -1,3 +1,4 @@
---format documentation
 --color
+--order random
+--format documentation
 --require spec_helper

data/.rubocop.yml

@@ -1,13 +1,28 @@
 AllCops:
   TargetRubyVersion: 2.6
 
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: single_quotes
+# ------------------------------------------------------- Layout -------------------------------------------------------
 
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Layout/MultilineAssignmentLayout:
+  Enabled: false
 
 Layout/LineLength:
   Max: 120
+
+# ------------------------------------------------------- Style --------------------------------------------------------
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/README.md

@@ -1,24 +1,24 @@
 # PonyBreeds
 
-TODO: Delete this and the text below, and describe your gem
-
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pony_breeds`. To experiment with that code, run `bin/console` for an interactive prompt.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add pony_breeds
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install pony_breeds
 
 ## Usage
 
-TODO: Write usage instructions here
+Get the pony data by the symbolized JSON key
+    `Pony::Breeds::ReadPonyData.new.get_pony_by_key(:symbolized_key_from_json)`
+    
+Get the pony data by the actual name of the pony
+    `Pony::Breeds::ReadPonyData.new.get_pony_by_name('Actual Pony Name')`
 
 ## Development
 
@@ -28,7 +28,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pony_breeds. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/pony_breeds/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/napster235/pony_breeds. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/pony_breeds/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/breeds.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'pony/breeds/version'
+
+module Pony
+  module Breeds
+    class Error < StandardError; end
+  end
+end

data/lib/pony/breeds/pony_breeds.json

@@ -0,0 +1,20 @@
+{
+  "american_shetland_pony": {
+    "name": "American Shetland Pony",
+    "description": "The American Shetland Pony is an American breed of pony. It derives from the traditional Shetland Pony from the Shetland Isles of Scotland, but as a result of cross-breeding with other horse and pony breeds, is taller and more elegant",
+    "wiki_url": "https://en.wikipedia.org/wiki/American_Shetland_Pony"
+  },
+  "american_walking_pony": {
+    "name": "American Walking Pony",
+    "description": "The American Walking Pony is a modern American breed of gaited riding pony. It was created by crossbreeding of the Tennessee Walking Horse and the Welsh Pony.",
+    "wiki_url": "https://en.wikipedia.org/wiki/American_Walking_Pony"
+  },
+  "andalou_pony": {
+    "name": "Andalou Pony",
+    "description":"The Anadolu Pony is descended from crosses of Turkoman, Arabian, Persian, Karabakh, Akhal-Teke, Karbada, Deliboz, Mongolian and the ancient Anatolia horse. Some books refer to this small pony as the Native Turkish Pony, or Turk, but Professors Salahattin Batu and M. Nurettin Aral made a distinction in types between the horses in Anatolia as Anadolu and East and Southeast Anadolu.",
+    "wiki_url": "https://en.wikipedia.org/wiki/Anadolu_Pony"
+  },
+  "assateague_pony": {
+
+  }
+}

data/lib/pony/breeds/read_pony_data.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'active_support/core_ext/hash/keys'
+
+module Pony
+  module Breeds
+    # The ReadPonyData class provides a way to read the pony data from the stored json file
+    class ReadPonyData
+      # Get data related to a pony by JSON key
+      #
+      # @param key [Symbol] the symbolized key used to retrieve data for a specific pony
+      #
+      # @return [Hash] the hash containing the data for the pony
+      def get_pony_by_key(key)
+        read_ponies[key.to_sym]
+      end
+
+      # Get data related to a pony by the actual name of the pony
+      #
+      # @param name [String] the actual name of the pony
+      #
+      # @return [Hash] the hash containing the data for the pony
+      def get_pony_by_name(name)
+        key = name&.split&.join('_')&.downcase
+        get_pony_by_key(key.to_sym)
+      end
+
+      private
+
+      # Read and parse the JSON file
+      #
+      # @return [Hash] the data from the json file
+      def read_ponies
+        file_location = File.dirname(__FILE__)
+        load_pony_breeds = File.join(file_location, 'pony_breeds.json')
+        JSON.parse(File.read(load_pony_breeds)).deep_symbolize_keys
+      end
+    end
+  end
+end

data/lib/pony/breeds/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Pony
+  module Breeds
+    VERSION = '0.1.1'
+  end
+end

data/pony_breeds.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/pony/breeds/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'pony_breeds'
+  spec.version = Pony::Breeds::VERSION
+  spec.authors = ['napster235']
+  spec.email = ['dragomir.tuddor@gmail.com']
+
+  spec.summary = 'A small little gem that offers the capability of reading pony breeds.'
+  spec.description = 'A small little gem that offers the capability of reading pony breeds.'
+  spec.homepage = 'https://github.com/napster235/pony_breeds'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = 'https://github.com/napster235/pony_breeds'
+  spec.metadata['source_code_uri'] = 'https://github.com/napster235/pony_breeds'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rails', '>= 5.2', '< 7'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pony_breeds
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
-- Dragomir, Tudor
+- napster235
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-26 00:00:00.000000000 Z
+date: 2023-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,7 +30,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
-description: Write a longer description or delete this line.
+description: A small little gem that offers the capability of reading pony breeds.
 email:
 - dragomir.tuddor@gmail.com
 executables: []
@@ -44,10 +44,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/pony_breeds.rb
-- lib/pony_breeds/pony_breeds.json
-- lib/pony_breeds/pony_breeds.rb
-- lib/pony_breeds/version.rb
+- lib/breeds.rb
+- lib/pony/breeds/pony_breeds.json
+- lib/pony/breeds/read_pony_data.rb
+- lib/pony/breeds/version.rb
+- pony_breeds.gemspec
 homepage: https://github.com/napster235/pony_breeds
 licenses:
 - MIT
@@ -73,5 +74,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Write a short summary, because RubyGems requires one.
+summary: A small little gem that offers the capability of reading pony breeds.
 test_files: []

data/lib/pony_breeds/pony_breeds.json

@@ -1,14 +0,0 @@
-{
-  "american_shetland_pony":
-    {
-      "name": "American Shetland Pony",
-      "description": "The American Shetland Pony is an American breed of pony. It derives from the traditional Shetland Pony from the Shetland Isles of Scotland, but as a result of cross-breeding with other horse and pony breeds, is taller and more elegant",
-      "wiki_url": "https://en.wikipedia.org/wiki/American_Shetland_Pony"
-    },
-  "american_walking_pony":
-    {
-      "name": "American Walking Pony",
-      "description": "The American Walking Pony is a modern American breed of gaited riding pony. It was created by crossbreeding of the Tennessee Walking Horse and the Welsh Pony.",
-      "wiki_url": "https://en.wikipedia.org/wiki/American_Walking_Pony"
-    }
-}

data/lib/pony_breeds/pony_breeds.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-require 'active_support/core_ext/hash/keys'
-
-# Pony breeds module
-module PonyBreeds
-  def self.get_pony_by_key(key)
-    read_ponies[key.to_sym]
-  end
-
-  def self.get_pony_name(name)
-    key = name.split.join('_').downcase
-    get_pony_by_key(key)
-  end
-
-  def self.read_ponies
-    file_location = File.dirname(__FILE__)
-    load_pony_breeds = File.join(file_location, 'pony_breeds.json')
-    JSON.parse(File.read(load_pony_breeds)).deep_symbolize_keys
-  end
-end
-
-puts PonyBreeds.get_pony_name('American Shetland Pony')

data/lib/pony_breeds/version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module PonyBreeds
-  VERSION = '0.1.0'
-end

data/lib/pony_breeds.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'pony_breeds/version'
-
-module PonyBreeds
-  class Error < StandardError; end
-end