phil_locator 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e978eb880a0edcaa18f658d372ea980b4ca09b0f60db00c940ad0b125ad36e37
-  data.tar.gz: ff7a612e3f7d8bf60bc0942b0dd8d395027e54efffa0b9eb8793d3f96bb4a1df
+  metadata.gz: 7d12c866185b3ac196dd2c202802764a178c7663d15fe084e9e993269579a0fc
+  data.tar.gz: d41b0da954548f50efb380e1059ed3fc02a134a4fdf4fdec2ca0b9f8e5dba713
 SHA512:
-  metadata.gz: 80e2e04357371c369899fb7c7688ad7180e0e8b703c2e598165f118fdcff7df901190ce4a11f3d88e14ab639f3030ee22fe6c671af7bbdcb341bfa1a2bfe2ea2
-  data.tar.gz: 669289327aabc13114fbcb2f31686ee9c6e1c10b63fa765c2ccc9311267c7aeeba22d7084b496e248fd32b8aa38343fff0ff2017ba7cf372500f87aa1319264e
+  metadata.gz: 936dd12ab5f7cd65acee6c9b45f7c08184d6e6d6a906ef0b0cdfa7c98bea147d8dc2ee51457a4b016b036936a3d451aed24ee763422c7fe4162937f6b1739307
+  data.tar.gz: 8b9db0d51dee215b70bade15c1e09df50502342cbcf4bd72b6233f99fd14f164666aac01dc1a97a0264ec15b132c9641962fe93189c9b5b81bf6ccf9a56e9aa3

data/README.md

@@ -1,5 +1,7 @@
 # Phil Locator
 
+[![Gem Version](https://badge.fury.io/rb/phil_locator.svg)](https://badge.fury.io/rb/phil_locator)
+
 ## Build Status
 [![Maintainability](https://api.codeclimate.com/v1/badges/9cc2694e0d4b21080edc/maintainability)](https://codeclimate.com/github/tenshiAMD/phil_locator/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/9cc2694e0d4b21080edc/test_coverage)](https://codeclimate.com/github/tenshiAMD/phil_locator/test_coverage)
@@ -11,12 +13,12 @@ Provides registry records for `regions`, `cities`, `provinces`, and `barangays`
 
 In Gemfile:
 ```
-gem "phil_locator", "~> 1.1.0"
+gem "phil_locator", "~> 1.2.0"
 ```
 
 Or, from the command line:
 ```
-gem install phil_locator -v "~> 1.1.0"
+gem install phil_locator -v "~> 1.2.0"
 ```
     
 ## Usage
@@ -35,6 +37,17 @@ PhilLocator::City.all
 PhilLocator::Barangay.all
 ```
 
+## Configuration
+
+Create an initializer `phil_locator.rb` to configure the options, here's a sample provided below
+
+```
+PhilLocator.configure do |config|
+    # This overrides the default data directory
+    config.data_root_path = Rails.root.join("data").to_s
+end
+```
+
 ## Copyright
 
 Copyright (c) 2019 Angel Aviel Domaoan, released under the [MIT license](/LICENSE).

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/app/models/phil_locator/barangay.rb

@@ -2,7 +2,7 @@ module PhilLocator
   class Barangay < ActiveYaml::Base
     include ActiveHash::Associations
 
-    set_root_path [Gem.loaded_specs[self.module_parent.to_s.underscore].full_gem_path, "data"].join("/")
+    set_root_path self.module_parent.data_root_path
     set_filename "barangays"
 
     belongs_to :city, class_name: "PhilLocator::City", foreign_key: :city_code, primary_key: :code

data/app/models/phil_locator/city.rb

@@ -2,7 +2,7 @@ module PhilLocator
   class City < ActiveYaml::Base
     include ActiveHash::Associations
 
-    set_root_path [Gem.loaded_specs[self.module_parent.to_s.underscore].full_gem_path, "data"].join("/")
+    set_root_path self.module_parent.data_root_path
     set_filename "cities"
 
     belongs_to :province, class_name: "PhilLocator::Province", foreign_key: :province_code, primary_key: :code

data/app/models/phil_locator/province.rb

@@ -2,7 +2,7 @@ module PhilLocator
   class Province < ActiveYaml::Base
     include ActiveHash::Associations
 
-    set_root_path [Gem.loaded_specs[self.module_parent.to_s.underscore].full_gem_path, "data"].join("/")
+    set_root_path self.module_parent.data_root_path
     set_filename "provinces"
 
     belongs_to :region, class_name: "PhilLocator::Region", foreign_key: :region_code, primary_key: :code

data/app/models/phil_locator/region.rb

@@ -2,7 +2,7 @@ module PhilLocator
   class Region < ActiveYaml::Base
     include ActiveHash::Associations
 
-    set_root_path [Gem.loaded_specs[self.module_parent.to_s.underscore].full_gem_path, "data"].join("/")
+    set_root_path self.module_parent.data_root_path
     set_filename "regions"
 
     has_many :provinces, class_name: "PhilLocator::Province", foreign_key: :region_code, primary_key: :code

data/lib/phil_locator/configuration.rb

@@ -0,0 +1,9 @@
+module PhilLocator
+  class Configuration
+    attr_accessor :data_root_path
+
+    def initialize
+      @data_root_path = [PhilLocator.gem_full_path, "data"].join("/")
+    end
+  end
+end

data/lib/phil_locator/version.rb

@@ -1,7 +1,6 @@
 require_relative "gem_version"
 
 module PhilLocator
-  # Returns the version of the currently loaded Active Job as a <tt>Gem::Version</tt>
   def self.version
     gem_version
   end

data/lib/phil_locator.rb

@@ -1,9 +1,34 @@
 require "active_hash"
 
+require "phil_locator/configuration"
 require "phil_locator/version"
 
 module PhilLocator
   extend ActiveSupport::Autoload
+
+  mattr_writer :configuration
+
+  def self.configuration
+    @configuration ||= PhilLocator::Configuration.new
+  end
+
+  def self.configure
+    yield configuration if block_given?
+  end
+
+  def self.data_root_path
+    raise "`#{name}.data_root_path` MUST be a String object." unless configuration.data_root_path.is_a?(String)
+
+    configuration.data_root_path
+  end
+
+  def self.gem_full_path
+    Gem.loaded_specs[gem_name].full_gem_path
+  end
+
+  def self.gem_name
+    name.underscore
+  end
 end
 
 require "phil_locator/engine"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phil_locator
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Angel Aviel Domaoan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-18 00:00:00.000000000 Z
+date: 2019-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_hash
@@ -47,6 +47,7 @@ files:
 - data/provinces.yml
 - data/regions.yml
 - lib/phil_locator.rb
+- lib/phil_locator/configuration.rb
 - lib/phil_locator/engine.rb
 - lib/phil_locator/gem_version.rb
 - lib/phil_locator/version.rb
@@ -56,7 +57,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/tenshiAMD/phil_locator/issues
-  source_code_uri: https://github.com/tenshiAMD/phil_locator/tree/v1.1.0
+  source_code_uri: https://github.com/tenshiAMD/phil_locator/tree/v1.2.0
 post_install_message: 
 rdoc_options: []
 require_paths: