fixme 4.1.0 → 6.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 542218a87018613a2dc76f20bcdd28b66f40ea6a
-  data.tar.gz: ed4c8ed714fa465784188e8378aaad038ef06c41
+SHA256:
+  metadata.gz: 16e16af88b6b78de4b441bad22260a6ebadc1bc2daaeff1a1244c43b715da874
+  data.tar.gz: cdfc448199b5ddeb1ae6f7efd6fb801002b40f994dc78fc63309183f6f347c85
 SHA512:
-  metadata.gz: deb1c1a6d45e97291628ed1ad53b3ad590a0f7bbc4c39cba97a62dc7e4c4d65806bbfa509f262a1c9045f42b5a0bce0257852b37fe704d17c73e6b592d22280e
-  data.tar.gz: 52c1ed22af9e8a1b5b7b1c0ea8b62ba090a6b72f7fffac5f6d8d99fd511abb3bddef0b667b5c742968aca0415c9d6f8e5d666db6e4929d23ffbb3d486ad42801
+  metadata.gz: 320d27cacd701df672ec5fb7dcbcb31feb9017fd4e06d294828a94bc4775a566be772806076f5d4c96f2cd23a05092d763648f23179957dd8305c2a25e5b5f3e
+  data.tar.gz: 91ed853d3d34ea23789c2f042c1db46c430303fa4ea07b55fae8e25d9602478a40eba6624b8d3a827c99e7c758fd2d045e75d1c452c81433842a6f4ff19b4e90

data/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: Ruby CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ["3.0", "2.7", "2.6"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@ae9cb3b565e36682a2c6045e4f664388da4c73aa
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## 6.1.0
+
+* Checks `APP_ENV`, not just `RACK_ENV`, as this is [what Sinatra now encourages using](https://github.com/sinatra/sinatra/blob/master/CHANGELOG.md#200--2017-04-10).
+
+## 6.0.0
+
+* Require zero-padded month and day, i.e. disallow `2019-1-2`. This enforced consistency makes it easier to grep for an exploded FIXME.
+
+## 5.0.0 and earlier
+
+* Please see commit history, or make a pull request to update this file.

data/README.md

@@ -2,7 +2,7 @@
 
 FIXME comments that raise after a certain point in time:
 
-```
+```ruby
 FIXME "2014-07-31: Stop hard-coding currency."
 currency = "USD"
 ```
@@ -20,11 +20,9 @@ You may want to use these bad boys next to:
 
 For simplicity, the date comparison uses machine-local time (not e.g. the Rails configured time zone).
 
-Protip: make sure it's clear from the exception or from a separate comment just what should be done – sometimes not even the person who wrote the quickfix will remember what you're meant to change.
-
 ### Environment awareness
 
-If `Rails.env` (Ruby on Rails) or `ENV["RACK_ENV"]` (e.g. Sinatra) is present, it will only ever raise in the `"test"` and `"development"` environments. That is, the production app will never raise these exceptions.
+If `Rails.env` (Ruby on Rails), `ENV["APP_ENV"]` or `ENV["RACK_ENV"]` (e.g. Sinatra) is present, it will only ever raise in the `"test"` and `"development"` environments. That is, the production app will never raise these exceptions.
 
 ### Do something other than raise
 
@@ -32,7 +30,7 @@ When these exceptions trigger on your CI server they stop the line, blocking you
 
 So you can configure the library to do something other than raise:
 
-```
+```ruby
 # In a Rails project, this might be in config/initializers/fixme.rb
 Fixme.explode_with do |details|
   YourOwnCodeOrSomeLibrary.email_developers(details.full_message)
@@ -44,7 +42,7 @@ There's also `details.date`, `details.due_days_ago`, `details.message` and `deta
 
 You can call `Fixme.raise_from(details)` to get the default behavior, if you want that under certain conditions:
 
-```
+```ruby
 Fixme.explode_with do |details|
   if details.due_days_ago > 5
     Fixme.raise_from(details)
@@ -58,6 +56,11 @@ end
 
 If you e.g. don't want your CI server to raise, make it set the environment variable `DISABLE_FIXME_LIB`.
 
+### Pro-tips
+
+* Make sure it's clear from the exception or from a separate comment just what should be done – sometimes not even the person who wrote the FIXME will remember what you're meant to change.
+* If a FIXME raises right in a class/module, rather than inside a method, there may be follow-on errors (about missing methods and such) since the rest of that file won't execute. Being aware of this can help understand otherwise confusing CI failures.
+
 
 ## Installation
 

data/fixme.gemspec

@@ -11,13 +11,14 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Comments that raise after a certain point in time.}
   spec.homepage      = ""
   spec.license       = "MIT"
+  spec.metadata      = { "rubygems_mfa_required" => "true" }
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "timecop"

data/lib/fixme/version.rb

@@ -1,3 +1,3 @@
 module Fixme
-  VERSION = "4.1.0"
+  VERSION = "6.1.1"
 end

data/lib/fixme.rb

@@ -2,7 +2,8 @@ require "fixme/version"
 require "date"
 
 module Fixme
-  UnfixedError = Class.new(StandardError)
+  # We intentionally do NOT inherit from StandardError, because we don't want these errors caught by a blanket "rescue".
+  UnfixedError = Class.new(Exception)
 
   Details = Struct.new(:full_message, :backtrace, :date, :message) do
     def due_days_ago
@@ -63,7 +64,11 @@ module Fixme
     private
 
     def framework_env
-      defined?(Rails) ? Rails.env : ENV["RACK_ENV"]
+      if defined?(Rails)
+        Rails.env
+      else
+        ENV["RACK_ENV"] || ENV["APP_ENV"]
+      end
     end
 
     def disallow_timecop(&block)
@@ -75,10 +80,10 @@ module Fixme
     end
 
     def parse
-      match = @date_and_message.match(/\A(\d\d\d\d-\d\d?-\d\d?): (.+)\z/)
+      match = @date_and_message.match(/\A(\d\d\d\d-\d\d-\d\d): (.+)\z/)
 
       unless match
-        raise %{FIXME does not follow the "2015-01-01: Foo" format: #{@date_and_message.inspect}}
+        raise %{FIXME does not follow the "2015-01-31: Foo" format: #{@date_and_message.inspect}}
       end
 
       raw_date, message = match.captures

data/spec/fixme_spec.rb

@@ -29,7 +29,7 @@ describe Fixme, "#FIXME" do
   it "truncates the backtrace to exclude the library itself" do
     begin
       FIXME "2013-12-31: Remove this stuff."
-    rescue => e
+    rescue Fixme::UnfixedError => e
       expect(e.backtrace.first).to include("fixme_spec.rb:")
     end
   end
@@ -41,10 +41,16 @@ describe Fixme, "#FIXME" do
     }.to raise_error("Fix by 2013-12-31: Remove this: and this.")
   end
 
-  it "complains if the desired format is not adhered to" do
+  it "complains if the desired message format is not adhered to" do
     expect {
       FIXME "9999-01-01, Learn to: type"
-    }.to raise_error(%{FIXME does not follow the "2015-01-01: Foo" format: "9999-01-01, Learn to: type"})
+    }.to raise_error(%{FIXME does not follow the "2015-01-31: Foo" format: "9999-01-01, Learn to: type"})
+  end
+
+  it "complains if the extended ISO 8601 date format is not adhered to" do
+    expect {
+      FIXME "9999-01-1: Foo"
+    }.to raise_error(%{FIXME does not follow the "2015-01-31: Foo" format: "9999-01-1: Foo"})
   end
 
   it "is available everywhere" do
@@ -55,6 +61,15 @@ describe Fixme, "#FIXME" do
     }.to raise_error(Fixme::UnfixedError)
   end
 
+  it "is not caught by a blanket 'rescue'" do
+    expect {
+      begin
+        FIXME "2000-01-01: Don't be caught."
+      rescue
+      end
+    }.to raise_error(Fixme::UnfixedError)
+  end
+
   it "is not fooled by the Timecop gem" do
     future_date = Date.today + 2
 
@@ -86,7 +101,31 @@ describe Fixme, "#FIXME" do
     end
   end
 
-  context "when a Rack environment is detected" do
+  context "when an APP_ENV is detected" do
+    before do
+      stub_env "DISABLE_FIXME_LIB", nil
+    end
+
+    it "raises in the 'test' environment" do
+      stub_env "RACK_ENV", nil
+      stub_env "APP_ENV", "test"
+      expect_to_raise
+    end
+
+    it "raises in the 'development' environment" do
+      stub_env "RACK_ENV", nil
+      stub_env "APP_ENV", "development"
+      expect_to_raise
+    end
+
+    it "does not raise in other environments" do
+      stub_env "RACK_ENV", nil
+      stub_env "APP_ENV", "production"
+      expect_not_to_raise
+    end
+  end
+
+  context "when a RACK_ENV is detected" do
     before do
       stub_env "DISABLE_FIXME_LIB", nil
     end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: fixme
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 6.1.1
 platform: ruby
 authors:
 - Henrik Nyh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-30 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -73,7 +73,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -84,7 +86,8 @@ files:
 homepage: ''
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -100,8 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.2.31
 signing_key: 
 specification_version: 4
 summary: Comments that raise after a certain point in time.