date_as_bool 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e2b4fb4fb7506c04047aa82aebe688e26505d5ab
+  data.tar.gz: a3473d477d4a5a47d625f674fb0f3f4fb1c0778f
+SHA512:
+  metadata.gz: e6a837110cc0f3b01f8ab4cb2161b2b663f99dfe212b1c3a0bdb37bf43d99b893eac1c829713fe549123a39c10000671ab501279bd7729302a390be1bde696f8
+  data.tar.gz: 1d3584c5e18dcbd8b2c63ccb34f4ebec6730386b4cad4d02a79104b0f3486244cf2f7622d5af76863411f98d34cc02d244eb2119a2f1059b60876023c7186027

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Carlo Martinucci
+
+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,74 @@
+# DateAsBool
+A simple Rails Gem to get both a datetime and a boolean behaviour from the same database column. I found myself quite often with the following design pattern:
+
+```ruby
+# == Schema Information
+#
+# Table name: subscriptions
+#
+#  id                           :integer          not null, primary key
+#  paid_at                      :datetime
+#  ...
+#
+
+class Subscription < ApplicationRecord
+  attr_accessor :paid
+  def paid=(bool)
+    self.paid_at = bool ? Time.now : nil
+  end
+  def paid
+    paid_at.present?
+  end
+  def paid!
+    paid = true
+    save
+  end
+  def paid?
+    paid_at.present?
+  end
+  ...
+```
+
+This gem abstracts this behaviour in one line.
+
+
+## Usage
+Let's say you have a `users` table with column `verified_at:datetime`.
+
+Add
+```ruby
+class User < ApplicationRecord
+  date_as_bool :verified_at
+  ...
+```
+
+Now you can use `user.verified?` to test for `verified_at` presence, and `user.verified!` as an alias for `user.update(verified_at: Time.now)`.
+
+You can also reset the field or change it dynamically with `user.update(verified: bool)`. If false, it resets `verified_at` to `nil`.
+
+
+## Advanced Usage
+If you want to give a different name to the boolean method, you can specify it as the second argument: `date_as_bool :verified_at` gets translated to `date_as_bool :verified_at, :verified`.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'date_as_bool'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install date_as_bool
+```
+
+## Contributing
+Pull requests are greatly appreciated. This is my first gem, intended mainly for learning purposes. Its only target is to capture a small design pattern which may be safer to implement just by copy&paste.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,33 @@
+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    = 'DateAsBool'
+  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/date_as_bool/active_record/as/active_record.rb

@@ -0,0 +1,3 @@
+ActiveSupport.on_load :active_record do
+  extend ActiveRecord::As::Bool::ClassMethods
+end

data/lib/date_as_bool/active_record/as/bool.rb

@@ -0,0 +1,34 @@
+module ActiveRecord
+  module As #:nodoc:
+    module Bool #:nodoc:
+
+      module ClassMethods
+        def date_as_bool datetime_name, bool_name=nil
+          caller_class = self
+
+          if bool_name.nil?
+            bool_name = datetime_name.to_s.split("_")[0..-2].join("_").to_sym
+          end
+
+          caller_class.class_eval do
+            attr_accessor bool_name
+            define_method bool_name do
+              self.send(datetime_name).present?
+            end
+            define_method :"#{bool_name}=" do |bool|
+              self.send(:"#{datetime_name}=", bool ? Time.now : nil)
+            end
+            define_method :"#{bool_name}!" do
+              self.send(:"#{bool_name}=", true)
+              self.save!
+            end
+            define_method :"#{bool_name}?" do
+              self.send(bool_name)
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/date_as_bool/version.rb

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

data/lib/date_as_bool.rb

@@ -0,0 +1,7 @@
+require "date_as_bool/active_record/as/bool"
+require "date_as_bool/active_record/as/active_record"
+
+# module DateAsBool
+
+
+# end

data/lib/tasks/date_as_bool_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :date_as_bool do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: date_as_bool
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Carlo Martinucci
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.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'
+description: A simple Rails Gem to get both a datetime and a boolean behaviour from
+  the same database column, i.e. have a verified_at:datetime to log times of verification
+  and sort, and also .verified? and .verify! methods.
+email:
+- carlo.martinucci@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/date_as_bool.rb
+- lib/date_as_bool/active_record/as/active_record.rb
+- lib/date_as_bool/active_record/as/bool.rb
+- lib/date_as_bool/version.rb
+- lib/tasks/date_as_bool_tasks.rake
+homepage: https://carlomartinucci.github.io/date_as_bool
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Get both a datetime and a boolean behaviour with only one column.
+test_files: []