black_friday 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2260601ce9035dd0846d9f84db09d81aabb2fe7cb1331af41a136b44c678d8b
-  data.tar.gz: a140a287cce7c482df823d1a5742d0d9be71603a68cf87623772ec18cfd0809b
+  metadata.gz: 7966bbf57ee41cf2517eb0dec3ca6195cb6b64f524cc6a7a05b2b5ffa38c666f
+  data.tar.gz: eb327004e46a88dbbd45ad513142ff790ce5bf85abe287ef5e0537eab6afc042
 SHA512:
-  metadata.gz: 67c75167093132f46767698201dc71c6a6363bc278791e8c4ff9db8f98fe97fd4f498f6d346ce58e120849a11fbe5a2a975be8ca93f76a770a1dda04edbdbba3
-  data.tar.gz: 55a691ac58f7a7c22b766413ad5f75bb626bd0a6e2deeb5655ad7c8441aa462035d15a2c0a3ac1d354ee335872d0ffe982c8f96d902f982eb883ab1921f6602b
+  metadata.gz: 49b2d7aa8c84b5c01e0fb451fb72e3c1e2d467fc82bf80a17a44a6281374da6f19d4eb6df0ec10dccb39aac2341680a38d1bdc428e88ef1afb75c648ab122f3d
+  data.tar.gz: 477c1820b56c6d7cb13de244299b81b3aed8cea4c7eb812b57a905f18f0831fd9a2e35a1b8c4ff2032488f683bb5da94d6c6a115019f650238a45f16928e0a4b

data/README.md

@@ -1,28 +1,67 @@
 # BlackFriday
 
-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/black_friday`. To experiment with that code, run `bin/console` for an interactive prompt.
+Add Black Friday sales to your Rails app.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_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:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add black_friday
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+## Usage
 
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+### Date helpers
+
+Black Friday provides some helpers for dates. You can also pass in the year which can be helpful for making reports for previous years.
+
+```ruby
+BlackFriday.thanksgiving #=> Thu, 28 Nov 2024
+BlackFriday.black_friday #=> Fri, 29 Nov 2024
+BlackFriday.cyber_monday #=> Mon, 2 Dec 2024
+
+BlackFriday.thanksgiving(2029) #=> Thu, 22 Nov 2029
 ```
 
-## Usage
+### Adding Sales
+
+Sales are handy to set the date/time range for a sale. The `add_sale` block should return a `Range`.
+
+```ruby
+BlackFriday.add_sale do
+  thanksgiving.monday.beginning_of_day..cyber_monday.end_of_day
+end
 
-TODO: Write usage instructions here
+BlackFriday.add_sale :labor_day do
+  # First Monday in September
+  sep_1st = Date.new(Date.today.year, 9, 1)
+  labor_day = sep_1st.monday? ? sep_1st : sep_1st.next_occurring(:monday)
+  start_day = labor_day - 3.days
+
+  start_day.beginning_of_day..labor_day.end_of_day
+end
+```
+
+You can then check if a sale is active:
+
+```ruby
+BlackFriday.active?
+#=> true/false
+
+# Or specific sale(s)
+BlackFriday.active?(:black_friday, :labor_day)
+#=> true/false
+```
+
+To check the active sales:
+
+```ruby
+BlackFriday.current_sale #=> :black_friday
+
+# For multiple sales at once
+BlackFriday.current_sales #=> [:black_friday]
+```
 
 ## Development
 

data/lib/black_friday/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BlackFriday
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/black_friday.rb

@@ -1,8 +1,55 @@
 # frozen_string_literal: true
 
 require_relative "black_friday/version"
+require "active_support/isolated_execution_state"
+require "active_support/core_ext/array/wrap"
+require "active_support/core_ext/numeric/time"
 
 module BlackFriday
+  extend self
+
   class Error < StandardError; end
-  # Your code goes here...
+
+  mattr_accessor :sales, default: {}
+
+  def add_sale(name = :black_friday, &block)
+    sales[name] = block
+  end
+
+  def active?(*sale_names)
+    blocks = sale_names.empty? ? sales.values : sales.values_at(*sale_names).compact
+    Array.wrap(blocks).any? do
+      in_range? instance_eval(&_1)
+    end
+  end
+
+  def current_sales
+    sales.select do |name, block|
+      in_range? instance_eval(&block)
+    end
+  end
+
+  def current_sale
+    current_sales.first
+  end
+
+  def in_range?(range)
+    range.include?(range.first.is_a?(Date) ? Date.today : Time.current)
+  end
+
+  # Date helpers
+
+  def thanksgiving(year = Date.today.year)
+    nov_1st = Date.new(year, 11, 1)
+    first_thursday = nov_1st.thursday? ? nov_1st : nov_1st.next_occurring(:thursday)
+    first_thursday + 3.weeks
+  end
+
+  def black_friday(year = Date.today.year)
+    thanksgiving(year) + 1.day
+  end
+
+  def cyber_monday(year = Date.today.year)
+    thanksgiving(year) + 4.days
+  end
 end

metadata

@@ -1,16 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: black_friday
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Chris Oliver
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-21 00:00:00.000000000 Z
-dependencies: []
-description: Manage Black Friday sales in your Rails apps
+date: 2024-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Black Friday sales in your Rails apps
 email:
 - excid3@gmail.com
 executables: []
@@ -51,5 +65,5 @@ requirements: []
 rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
-summary: Manage Black Friday sales in your Rails apps
+summary: Black Friday sales in your Rails apps
 test_files: []