time_for_a_boolean 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ccfb9d954ec1b87356eb15fcd7591c7e6deca75
-  data.tar.gz: 8c49ad2cec75e5264bed1cabf44f2754c748cc01
+  metadata.gz: b911b8e5eb898861b4bd685d9cca9077c24d2ac3
+  data.tar.gz: 4b608bfe50aad84b8db5de8420acb6652eb2dd56
 SHA512:
-  metadata.gz: 658e3d140b0e04e3000e2925254fa1402fe64098462f10a3415e2b5666cb88e12854f34b4623642afa22407a9e6c47dec850926efb6bdcaedc7eabc648b7aac4
-  data.tar.gz: 642f736c2fb5f85e98da4ac6ecf980e42885bad0958054e928f9ed2b700814368027e02055339c80e975befb96bf038b65f0228f0a55d0086e2183295b346084
+  metadata.gz: 3de77ccb1b78cf796faee950ef48f9593e7890480ba6407a0332ac6e13e5e64c48426f7be82f47fa6c2e7bf9828081e420f01300464a5098e0e5a4b82eefbc62
+  data.tar.gz: 28e4d3a903284312c50a1f4c69c474b39eb6114ae1f905a96d74ccbb580f73aa2f70f9468e46d894161c074a4caac29725ccec1af5bc809aaa0129e4d0f9f416

data/.ruby-version

@@ -1 +1 @@
-ruby-2.0.0-p247
+2.1.2

data/CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributing
+
+I love pull requests. Here's a quick guide:
+
+1. Fork the repo.
+2. Run the tests. I only take pull requests with passing tests, and it's great
+   to know that you have a clean slate: `bundle && rake`
+3. Add a test for your change. Only refactoring and documentation changes
+   require no new tests. If you are adding functionality or fixing a bug, I need
+   a test!
+4. Make the test pass.
+5. Make sure your changes adhere to the
+   [thoughtbot Style Guide](https://github.com/thoughtbot/guides/tree/master/style)
+6. Write an [awesome] [commit] [message].
+[awesome]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[commit]: http://robots.thoughtbot.com/post/48933156625/5-useful-tips-for-a-better-commit-message
+[message]: http://rakeroutes.com/blog/deliberate-git/
+6. Push to your fork and submit a pull request.
+7. At this point you're waiting on us. I like to at least comment on, if not
+   accept, pull requests within a few days (and, typically, one business
+   day). I may suggest some changes or improvements or alternatives.
+
+## Increase your chances of getting merged
+
+Some things that will increase the chance that your pull request is accepted,
+taken straight from the Ruby on Rails guide:
+
+1. Use Rails idioms and helpers
+2. Include tests that fail without your code, and pass with it
+3. Update the documentation, the surrounding one, examples elsewhere, guides,
+   whatever is affected by your contribution
+4. Syntax:
+   * Two spaces, no tabs.
+   * No trailing whitespace. Blank lines should not have any space.
+   * Prefer `&&`/`||`  over `and`/`or`.
+   * `MyClass.my_method(my_arg)` not `my_method( my_arg )` or `my_method my_arg`.
+   * `a = b` and not `a=b`.
+   * Follow the conventions you see used in the source already.
+5. And in case I didn't emphasize it enough: I love tests!

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Caleb Thompson and thoughtbot
+Copyright (c) 2013 Caleb Thompson
 
 MIT License
 

data/README.md

@@ -1,29 +1,79 @@
-# TimeForABoolean
+Time for A Boolean
+==================
 
-TODO: Write a gem description
+[![Build Status](https://travis-ci.org/calebthompson/time_for_a_boolean.png)](https://travis-ci.org/calebthompson/time_for_a_boolean)
+[![Code Climate](https://codeclimate.com/github/calebthompson/time_for_a_boolean.png)](https://codeclimate.com/github/calebthompson/time_for_a_boolean)
+[![Coverage Status](https://coveralls.io/repos/calebthompson/time_for_a_boolean/badge.png)](https://coveralls.io/r/calebthompson/time_for_a_boolean)
 
-## Installation
 
-Add this line to your application's Gemfile:
+> Sally: Hey, we need to add a flag to Post
 
-    gem 'time_for_a_boolean'
+> Jean: What for?
 
-And then execute:
+> Sally: Well, we want to let users "delete" posts, but not actually lose the
+         data.
 
-    $ bundle
+> Jean: Sounds reasonable. But what about later, when we have to know _when_ a
+  post was deleted?
 
-Or install it yourself as:
+> Sally: That's a good point, but if we add a timestamp now we have to write all
+         sorts of methods to keep a nice interface on Post...
 
-    $ gem install time_for_a_boolean
+> Jean: Time for A Boolean!
 
-## Usage
+Wait, what?
+-----------
 
-TODO: Write usage instructions here
+```
+rails generate migration AddDeletedAtToPosts deleted_at:timestamp
+```
 
-## Contributing
+```ruby
+class Post < ActiveRecord::Base
+  time_for_a_boolean :deleted
+  ...
+end
+```
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+```ruby
+class PostsController < ApplicationController
+  def show
+    @post = Post.find(params[:id])
+    if @post.deleted?
+      raise ActiveRecord::RecordNotFound
+    end
+  end
+
+  def destroy
+    post = Post.find(params[:id])
+    post.deleted = true
+    post.save
+    redirect_to posts_url
+  end
+end
+```
+
+You keep on saying things and I don't get it.
+---------------------------------------------
+
+Okay, let's take a look at what happens.
+
+When we call `time_for_a_boolean :deleted` in the Post class definition, several
+methods are defined:
+
+| Method          | Description
+| --------------- | -----------
+| `Post#deleted`  | `true` if `Post#deleted_at` is set, `false` otherwise
+| `Post#deleted?` | Alias for `Post#deleted`
+| `Post#deleted=` | Sets the timestamp to `DateTime.now` if the new value is true, and `nil` otherwise
+
+These methods allow you to use a timestamp as you would a boolean value in your
+application.
+
+Okay... why?
+------------
+
+* Audit for when a flag was set. Future you wants this.
+* `COUNT(posts.deleted_at)` gives you the count of deleted posts, which is
+  useful when writing a report. Define and use `Post.deleted.count` when you
+  have Ruby available.

data/Rakefile

@@ -1 +1,6 @@
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/time_for_a_boolean/version.rb

@@ -1,3 +1,3 @@
 module TimeForABoolean
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/time_for_a_boolean.rb

@@ -4,7 +4,10 @@ require 'time_for_a_boolean/railtie'
 
 module TimeForABoolean
   def time_for_a_boolean(attribute)
-    define_method(attribute) { !send("#{attribute}_at").nil? }
+    define_method(attribute) do
+      !send("#{attribute}_at").nil? &&
+        send("#{attribute}_at") <= -> { DateTime.now }.()
+    end
     alias_method "#{attribute}?", attribute
     define_method("#{attribute}=") do |value|
       if value

data/spec/time_for_a_boolean_spec.rb

@@ -1,3 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
 require 'time_for_a_boolean'
 
 describe TimeForABoolean do
@@ -22,7 +25,7 @@ describe TimeForABoolean do
   describe 'attribute method' do
     it 'calls nil? on the backing timestamp' do
       klass.time_for_a_boolean :attribute
-      timestamp = double(nil?: false)
+      timestamp = double(nil?: true)
       object.stub(attribute_at: timestamp)
 
       object.attribute
@@ -32,7 +35,7 @@ describe TimeForABoolean do
 
     it 'is true if the attribute is not nil' do
       klass.time_for_a_boolean :attribute
-      object.stub(attribute_at: true)
+      object.stub(attribute_at: DateTime.now - 10)
 
       expect(object.attribute).to be_true
     end
@@ -43,6 +46,13 @@ describe TimeForABoolean do
 
       expect(object.attribute).to be_false
     end
+
+    it 'is false if the attribute time is in the future' do
+      klass.time_for_a_boolean :attribute
+      object.stub(attribute_at: Time.now + 86400) # one day in the future
+
+      expect(object.attribute).to be_false
+    end
   end
 
   describe 'the query method' do

data/time_for_a_boolean.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
     or subscribed.
   DESCRIPTION
   spec.summary       = 'Back boolean values with timestamps'
-  spec.homepage      = 'https://github.com/thoughtbot/time_for_a_boolean'
+  spec.homepage      = 'https://github.com/calebthompson/time_for_a_boolean'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rails'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
 end

metadata

@@ -1,69 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: time_for_a_boolean
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Caleb Thompson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-31 00:00:00.000000000 Z
+date: 2014-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: rake
   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: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: |2
@@ -75,9 +89,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-gemset
-- .ruby-version
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
@@ -87,7 +102,7 @@ files:
 - lib/time_for_a_boolean/version.rb
 - spec/time_for_a_boolean_spec.rb
 - time_for_a_boolean.gemspec
-homepage: https://github.com/thoughtbot/time_for_a_boolean
+homepage: https://github.com/calebthompson/time_for_a_boolean
 licenses:
 - MIT
 metadata: {}
@@ -97,17 +112,17 @@ 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.0.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Back boolean values with timestamps