holidays_img 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5777df762392df78ec386a0c915ec1c90ee5abdd
-  data.tar.gz: 5f84598221af1370e21ffba12f54c8a60f87941c
+  metadata.gz: c0be67fcb81c827f829c0f1a7022e333477f958d
+  data.tar.gz: c3284d9944346ccbb5e348417fe82b887f7468b8
 SHA512:
-  metadata.gz: c25d8dfd62b0619121f82d14c1f08050bed852f1ca4c12999eee9fd350792f3a4f61c0caf8901497af8f334de57a7037be672849b060ac273098e82db480b3ac
-  data.tar.gz: 7f5d9b25098165e71220408bf6f802df7e4785c27c252a6c39b5b4605c82bed4ed9d70bb0d9410c4a6674111855871857171cb6f07ab7b03e43bc4fc7f60abd4
+  metadata.gz: d1769d5c8d1cf8f7ed95c95926b1c9a687ab3a3d280dbe5a71788bcf52eeebc73160499ecdfc25c26b1fad11df2dd31a41a4bb4728d35497bcd92183bb2b3e74
+  data.tar.gz: d85ea2729c79419e991d17dda9fddc2d29758ade4ff50b4f1d5058bb028a19c31733b361d0239f00530d934dee14579d89bbe16a712a74421359af14994c8a35

data/README.md

@@ -1,10 +1,12 @@
 # holidays_img
 
+[![Gem Version](https://badge.fury.io/rb/holidays_img.svg)](https://badge.fury.io/rb/holidays_img)
+
 This gem is a simple wrapper for Rails's `image_tag` helper. Leveraging the `holidays` gem, it allows you to easily load images based on the holiday occurring on any given date.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add the gem to your application's Gemfile:
 
 ```ruby
 gem 'holidays_img'
@@ -18,13 +20,19 @@ $ bundle
 
 ## Usage
 
-Simply use the `holidays_image_tag` helper as you would a standard Rails `image_tag`. To ensure proper loading of images, adhere to the following naming convention:
+Simply use the `holidays_image_tag` helper as you would a standard Rails `image_tag`:
+
+```
+<%= holidays_image_tag 'image.jpg' %>
+```
+
+To ensure proper loading of images, adhere to the following naming convention:
 
 - Have a default image, used for when a day does not fall on a holiday (also acts as a fallback for when a holiday image cannot be found)
-- Name your holiday images in the following format: `original_name_holiday_name`
+- Name your holiday images in the following format: `original_name_holiday_name.ext`
 - Ensure all holiday images are in the same directory
 
-Naming Examples:
+Naming Example:
 
 ```
 image.jpg
@@ -34,24 +42,27 @@ image_independence_day.jpg
 ...
 ```
 
-See the holiday gem's [definition files](https://github.com/holidays/definitions) for a list of holidays for any available region.
+See the Holidays gem's [definition files](https://github.com/holidays/definitions) for a list of holidays for any available region.
 
 ## Configuration
 
 You can configure options using an initializer:
 
 ```ruby
-# app/initializers/holidays_img.rb
+# config/initializers/holidays_img.rb
 
 HolidaysImg.configure do |config|
   # Load holidays based on region, defaults to :us
   config.region    = :ca
-  # Only load images for holidays you specify,
-  # defaults to all holidays observed for specified region
-  config.whitelist = ['Christmas Day']
+  # Only load images for holidays you specify
+  config.whitelist = ['Christmas Day', 'Mother\'s Day']
+  # Load custom holidays from file, can also pass array of file paths
+  config.custom_holidays = '/path/to/custom_holidays.yml'
 end
 ```
 
+For info on how to format custom holiday definitions, see the Holidays gem's [definition syntax documentation](https://github.com/holidays/definitions/blob/master/SYNTAX.md).
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/holidays_img/base.rb

@@ -7,5 +7,6 @@ module HolidaysImg
   extend Configuration
 
   define_setting :region, :us
-  define_setting :whitelist, []
+  define_setting :whitelist
+  define_setting :custom_holidays
 end

data/lib/holidays_img/image_tag_wrapper.rb

@@ -1,6 +1,8 @@
 module HolidaysImg
   module ImageTagWrapper
     def holidays_image_tag(source, options={})
+      Holidays.load_custom(HolidaysImg.custom_holidays) if HolidaysImg.custom_holidays
+
       date = options[:date] || Date.today
       holiday = Holidays.on(date, HolidaysImg.region).first
 
@@ -8,7 +10,7 @@ module HolidaysImg
         original_source = source.dup
         substring_index = source.rindex('.')
 
-        if HolidaysImg.whitelist.empty? || HolidaysImg.whitelist.include?(holiday[:name])
+        if HolidaysImg.whitelist.blank? || HolidaysImg.whitelist.include?(holiday[:name])
           source.insert(substring_index, "_#{holiday[:name].parameterize(separator: '_')}")
 
           unless File.exists?("#{Rails.root}/app/assets/images/#{source}")

data/lib/holidays_img/version.rb

@@ -1,3 +1,3 @@
 module HolidaysImg
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: holidays_img
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Zoran Pesic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-20 00:00:00.000000000 Z
+date: 2016-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: holidays