ActsAsBoolean 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c0417d76ff05c710f5eedb64ca52e39c00d483b1fa4e715d68c3eea466eb916e
+  data.tar.gz: fa54d9f4f9139695f661423c421212500d021eda7ce0eb23fbd00e633065c59b
+SHA512:
+  metadata.gz: ef9b9f525858a311c5c496d780f62606eb48534dacc8976e2e1a8cce8baf5fb2d1d6f06a42914f6d830aba631a45d0a7350c6206eb1f44c5a234003177f45117
+  data.tar.gz: d03c98928adbb547d147eb73608d8bf2df99728d0741ece9200053501deeb7fe2871e9a1bd171efdf5e543ea157ca9318c1717d7ed8aa50be4fe0174f7150b7f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Josh Brody
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,110 @@
+# ActsAsBoolean
+
+Treat time-y attributes like boolean attributes.
+    
+## Why
+
+Ruby is expressive. Expressive is sexy. ActiveRecord time-y objects are time-y objects. Time-y objects are a nightmare, and therefore, not sexy. 
+
+We like sexy.
+
+## How
+
+    class Post < ApplicationRecord
+      acts_as_boolean :published_at 
+    end 
+
+    class PostsController < ApplicationController
+      def index
+        @posts = Post.published 
+      end
+      
+      def show
+        @post = Post.find(params[:id])
+        unless @post.published?
+          raise ActiveRecord::RecordNotFound
+        end
+      end 
+    end  
+
+## What 
+
+Given `Post#published_at`:
+
+| Method            | Description
+| ----------------- | -----------
+| `Post#published`  | `true` if `Post#published_at` is greater than or equal to `Time.current`; otherwise `false` 
+| `Post#published?` | Sexy alias of `Post#published`
+| `Post#published=` | Sets the value of `published_at` to `Time.current` if the value passed is truth-y per `ActiveModel::Type::Boolean`; otherwise sets `published_at` to nil
+| `Post.published`  | Creates a scope of `Post.where('published_at <= ?', Time.current).where.not(published_at: nil)`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'acts_as_boolean'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+The great migration — you probably want an index here because we create a scope to the column:
+
+`rails g migration AddPublishedAtToPosts published_at:datetime:index`
+
+`rake db:migrate`
+
+Then drop it in:
+
+    class Post < ApplicationRecord
+      acts_as_boolean :published_at 
+    end
+    
+## Advanced configuration
+
+### Default time-y thing
+
+By default, `ActsAsBoolean` uses `Time.current`. Want to use `DateTime.now`? Great, just send in a `proc`.
+ 
+In `config/initializers/acts_as_boolean.rb`:
+
+```ruby
+ActsAsBoolean.timeish = -> { DateTime.now }
+```
+
+Want more control? Pass it in.
+
+```ruby
+class Post < ApplicationRecord
+  acts_as_boolean :published_at, time: -> { DateTime.now }
+end 
+```
+### New method name
+
+By default, `ActsAsBoolean` assumes you want `column_name.to_s.delete_suffix("_at")`. Given you have `published_pie` as your column name (which, of course, you do, because you love pie)...
+    
+```ruby
+class Post < ApplicationRecord
+  acts_as_boolean :published_pie, as: :published
+end 
+```    
+
+Want to control this globally?
+
+In `config/initializers/acts_as_boolean.rb`:
+
+```ruby
+ActsAsBoolean.normalize_column = -> (str) { str.gsub("_at", "") }
+```
+
+## Contributing
+
+Yes.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActsAsBoolean'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/acts_as_boolean.rb

@@ -0,0 +1,38 @@
+require "acts_as_boolean/railtie"
+
+module ActsAsBoolean
+  mattr_accessor :timeish, default: -> { Time.current }
+  mattr_accessor :normalize_column, default: -> (str) { str.to_s.delete_suffix("_at") }
+
+  module Extension
+    def acts_as_boolean(column_name, options = {})
+      options[:as] ||= ActsAsBoolean.normalize_column.call(column_name)
+      options[:time] ||= ActsAsBoolean.timeish
+      define_booleany_reader(column_name, options[:as], options[:time]) unless options[:reader]
+      define_booleany_writer(column_name, options[:as], options[:time]) unless options[:writer]
+      define_booleany_scope(column_name, options[:as], options[:time]) unless options[:scope]
+    end
+
+    def define_booleany_reader(original_column, booleany_column, time)
+      define_method("#{booleany_column}") do
+        return false if send(original_column).nil?
+        send(original_column) <= time.call
+      end
+      alias_method "#{booleany_column}?", booleany_column
+    end
+
+    def define_booleany_writer(original_column, booleany_column, time)
+      define_method("#{booleany_column}=") do |value|
+        if ActiveModel::Type::Boolean::FALSE_VALUES.exclude?(value)
+          send("#{original_column}=", time.call)
+        else
+          send("#{original_column}=", nil)
+        end
+      end
+    end
+
+    def define_booleany_scope(original_column, booleany_column, time)
+      scope booleany_column.to_sym, -> { where("#{original_column} <= ?", time.call).where.not(original_column.to_sym => nil) }
+    end
+  end
+end

data/lib/acts_as_boolean/railtie.rb

@@ -0,0 +1,9 @@
+module ActsAsBoolean
+  class Railtie < ::Rails::Railtie
+    initializer 'acts_as_boolean' do
+      ActiveSupport.on_load :active_record do
+        extend ActsAsBoolean::Extension
+      end
+    end
+  end
+end

data/lib/acts_as_boolean/version.rb

@@ -0,0 +1,3 @@
+module ActsAsBoolean
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: ActsAsBoolean
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Brody
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Treat time-y columns like booleans.
+email:
+- josh@josh.mn
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/acts_as_boolean.rb
+- lib/acts_as_boolean/railtie.rb
+- lib/acts_as_boolean/version.rb
+homepage: https://github.com/joshmn/acts_as_boolean
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Treat time-y columns like booleans.
+test_files: []