quotify 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f8b5ba09213aaa7238a8fd474560a9161fa5d6f6cda18137ef930d9d150b466
-  data.tar.gz: 321fa9889c476be3d53208e1d405db2f10df7d8639345dc728ef1744cbc32d30
+  metadata.gz: 947b696a1aadf9f898e7ab6024bee8553634995e2515821d3a84a5d0b9e7a8ca
+  data.tar.gz: ba7bed8d8578c3d68fa5ad0b7bc198b4d319d28c1a4176bb98eb9e721fd6cfae
 SHA512:
-  metadata.gz: 6a820edc5b569fddb1ee22f5fb3897e05ef95f27db82af818e0684ba95440e332dd04e86b7499bffc83dd60eef2c5ac0353e85fdca5acdc5625488ad0b3565dc
-  data.tar.gz: 6bc7e2d329df8156ca1c3f615ba77839c9fc1b4f298a75332207547b44599f4219962b259ce3d4af8c55efb040aefbe184b52a781ec64ce97b4ee209a58cb586
+  metadata.gz: c0ebbdcb57598bb013368885bbe0b2a2229f4e78edf47f3a4fa410df9221cc48c4a0c30f36a440d2ca24e2f19755c562a7ec4d0f6e03f15489ba25edcea29004
+  data.tar.gz: 11115de3813e56912a2a5d643230f3e240e00c72dccb0953ad0e3c7b2e6faa14828b7d33a9d77a278cf38bcb455e53461d8c412ff80a4f23f36dd09a15a6dfe8

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## V0.2.0rc
+Saves the quotes in memory to prevent too many IO operations. Added configs that can be updated at runtime. `quotes.yml` only works with symbols as keys. From now on, prioritize symbols over strings. A new field `updated_at` was added to `quotes.yml` to allow for updating quotes using gem command. This will be added in the future.
+
 ## V0.1.1
 Fixes documentations formatting. No additional features were added.
 

data/lib/quotify/quote.rb

@@ -12,21 +12,20 @@ module Quotify
     # @param author [#to_s] A specified author
     # @return [Quote] quote with author
     def initialize(quote: nil, author: nil)
-      quote_list = YAML.load_file(File.join(__dir__, 'quotes.yml')) unless quote && author
-      @quote = quote || quote_list['quotes'].sample
-      @author = author || quote_list['authors'].sample
+      @quote = quote || Quotify.config[:quotes].sample
+      @author = author || Quotify.config[:authors].sample
     end
 
     # Returns the quote and author in a string format
     # @option spacer [#to_s] Characters between quote and author
-    def to_s(spacer: " - ")
+    def to_s(spacer: Quotify.config[:default_spacer])
       "#{@quote}#{spacer}#{@author}"
     end
 
 
     # Returns the quote and author in a string format
     # @option spacer [#to_s] Characters between quote and author
-    def to_str(spacer: " - ")
+    def to_str(spacer: Quotify.config[:default_spacer])
       to_s(spacer: spacer)
     end
 

data/lib/quotify/quotes.yml

@@ -1,4 +1,6 @@
-authors:
+:updated_at: 2018-01-08
+:default_spacer: ' - '
+:authors:
 - Ivanka Trump
 - Dog The Bounty Hunter
 - Master Yoda
@@ -27,7 +29,7 @@ authors:
 - Olga
 - Logan Paul
 
-quotes:
+:quotes:
 - The ode lives upon the ideal, the epic upon the grandiose, the drama upon the real.
 - If we don't study the mistakes of the future we're doomed to repeat them for the
   first time.

data/lib/quotify.rb

@@ -4,6 +4,12 @@ require 'quotify/quote'
 # This module generates quotes on demand. Welcome to the future.
 module Quotify
 
+  @default_config = YAML.load_file(File.join(__dir__, 'quotify/quotes.yml'))
+
+  @config = @default_config.clone
+
+  @valid_config_keys = @config.keys
+
   # Generates a quote
   # @param quote [#to_s] A specified quote
   # @param author [#to_s] A specified author
@@ -11,4 +17,37 @@ module Quotify
   def self.generate(quote: nil, author: nil)
     Quote.new(quote: quote, author: author)
   end
+
+  # Outputs the configs of quotify-ruby
+  # @return [Hash]
+  def self.config
+    @config
+  end
+
+  # Configure through hash
+  # @param opts [Hash] A Hash of configurations
+  def self.configure(opts = {})
+    opts.each do |k,v|
+      @config[k.to_sym] = v if @valid_config_keys.include? k.to_sym
+    end
+  end
+
+  # Configure through yaml file
+  # @param path_to_yaml_file [Path] Path of the configuration file
+  def self.configure_with(path_to_yaml_file)
+    begin
+      config = YAML.load_file(path_to_yaml_file)
+    rescue Errno::ENOENT
+      puts "YAML configuration file couldn't be found. Using defaults."; return
+    rescue Psych::SyntaxError
+      puts "YAML configuration file contains invalid syntax. Using defaults."; return
+    end
+
+    configure(config)
+  end
+
+  # Resets the configurations
+  def self.reset_config
+    @config = @default_config.clone
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quotify
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Justin Leger