date_checkbox 0.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Matthias Viehweger
+
+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.rdoc

@@ -0,0 +1,88 @@
+= DateCheckbox
+
+This is a rails-plugin which can create a checkbox for attributes which are
+datetime-fields in the database. So, if you want to store the date when a user
+appected some terms or received some goods, but want to circumvent the need of
+selecting the proper date and time from 6 dropdowns, you can just use this
+plugin.
+
+It creates some wrapper-methods on the model for the attributes you specify and
+provides a form-helper which uses these. The model-methods also work with
+standard checkbox-tags.
+
+
+Personally, I do not want to go through the hassle of selecting the proper date
+and time from 6 dropdowns. I just want to check a checkbox and have my app to
+the rest. In many cases, this is even required security- or permission-wise.
+
+While this functionality is fairly easy to implement for one datetime-field
+(like terms_accepted_at), I don't like to repeat this code.
+
+Therefore, I put this rails-plugin together.
+
+A neat side-effect is, that I went and created a form-helper and added some
+useful model methods along the way.
+
+
+== Installation
+
+Just add
+
+  gem 'date_checkbox'
+
+to your Gemfile. If your not using Bundler and Rails3 by now, we can still be
+friends, but thats about it.
+
+
+== Example
+
+  # app/models/user.rb
+  class User < ActiveRecord::Base
+    has_date_checkbox :terms_accepted_at
+  end
+
+This adds the following three methods to the user-model:
+
+* terms_accepted   # returns "0" or "1"
+* terms_accepted=  # "1" sets to the current Time, otherwise sets to nil
+* terms_accepted?  # true or false
+
+You can use it the form-helper like this:
+
+  # app/views/users/_form.html.erb
+  <%= form_for @user do |f| %>
+    <p><%= f.date_checkbox :terms_accepted_at %></p>
+  <% end -%>
+
+The date_checkbox appends the date form the database if its selected. If you do
+not want that, simply use
+
+  f.checkbox :terms_accepted
+
+This is what f.date_checkbox uses anyway.
+
+
+== Notes
+
+Currently, I hook into ActionPack/ActionView directly, which is dirty by saves
+you from declaring a different FormBuilder for every form. I also refrained
+from changing the default-form builder for you because I don't want to conflict
+with other form-extensions you might want to use.
+
+If everything goes south, you can still use the model-methods. This is not (by
+any means) über-rocket-science. It's just convenient.
+
+Your turn.
+
+
+== Development
+
+Cpt. Obvious told me the following:
+
+  This is open-sourced on github.
+  You can contribute by sending pull-requests or just opening issues.
+
+He is obviously right and you also knew that. Any feedback is appreciated.
+
+
+Copyright (c) 2011 Matthias Viehweger, released under the MIT license

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+require 'sdoc'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the date_checkbox plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the date_checkbox plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  require File.expand_path('../lib/date_checkbox/version', __FILE__)
+
+  rdoc.rdoc_dir = 'doc/rdoc'
+  rdoc.title    = "DateCheckbox #{DateCheckbox::VERSION}"
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.options << '--charset=utf-8'
+  rdoc.options << '--fmt=shtml'
+
+  DateCheckbox::EXTRA_RDOC_FILES.each do |file|
+    rdoc.rdoc_files.include(file)
+  end
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO

@@ -0,0 +1,5 @@
+- make test run indepently
+  => this might mean that a host app needs to be generated.
+     after all, I depend on AR::Base and do only a little meta-progamming...
+- put onto travis
+- implement has_date_checkboxes *args

data/date_checkbox.gemspec

@@ -0,0 +1,30 @@
+# vim:ft=ruby:fileencoding=utf-8
+
+require File.expand_path('../lib/date_checkbox/version.rb', __FILE__)
+
+spec = Gem::Specification.new do |s|
+  s.name = "date_checkbox"
+  s.version = DateCheckbox::VERSION
+  s.date = DateCheckbox::DATE
+  s.summary = DateCheckbox::SUMMARY
+  s.description = DateCheckbox::DESCRIPTION
+
+  s.authors = ["Matthias Viehweger"]
+  s.email = 'kronn@kronn.de'
+  s.homepage = 'http://github.com/kronn/date_checkbox'
+  s.rubyforge_project = '[none]' # to supress the warning
+
+  s.require_paths = ["lib"]
+  s.files = `git ls-files`.split("\n") - ['.gitignore']
+  s.test_files = `git ls-files test`.split("\n")
+
+  s.rdoc_options = ['--charset=utf-8', '--fmt=shtml', '--all']
+  s.extra_rdoc_files = DateCheckbox::EXTRA_RDOC_FILES
+
+  s.add_dependency 'rails', '~> 3.0.0'
+
+  # for release and doc generation, more less optional
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rdoc', '>= 2.4.2'
+  s.add_development_dependency 'sdoc'
+end

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/date_checkbox.rb

@@ -0,0 +1,7 @@
+module DateCheckbox
+  autoload :HasDateCheckbox, 'date_checkbox/has_date_checkbox'
+  autoload :FormHelper,      'date_checkbox/form_helper'
+end
+
+ActiveRecord::Base.send(:include, DateCheckbox::HasDateCheckbox)
+ActionView::Helpers::FormBuilder.send(:include, DateCheckbox::FormHelper)

data/lib/date_checkbox/form_helper.rb

@@ -0,0 +1,12 @@
+module DateCheckbox
+  module FormHelper
+    def date_checkbox(attribute, options = {})
+      long, short = ( attribute.to_s =~ /_at$/ ) ?
+        [ attribute, attribute.to_s.sub(/_at$/, '') ] :
+        [ :"#{attribute}_at", attribute ]
+
+      info = object.send(long).to_date if object.send(:"#{short}?")
+      check_box(short) + info.to_s
+    end
+  end
+end

data/lib/date_checkbox/has_date_checkbox.rb

@@ -0,0 +1,46 @@
+module DateCheckbox
+  module HasDateCheckbox
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    module ClassMethods
+      def has_date_checkbox(db_field)
+        # if db_field.to_s =~ /_at$/ #&& has_attribute?(db_field)
+          column_name = db_field
+          method_name = db_field.to_s.sub(/_at$/, '')
+        # elsif has_attribute?(:"#{db_field}_at")
+        # else
+        #   column_name = :"#{db_field}_at"
+        #   method_name = db_field.to_s
+        # end
+
+        # send :include, InstanceMethods
+        class_eval do
+          define_method("#{method_name}") do
+            if attribute_present?(column_name)
+              "1" # I18n.t(:"is_#{method_name}")
+            else
+              "0" # I18n.t(:"not_#{method_name}")
+            end
+          end
+
+          define_method("#{method_name}?") do
+            attribute_present?(column_name)
+          end
+
+          define_method("#{method_name}=") do |value|
+            if value.to_s == "0"
+              write_attribute(column_name, nil)
+            else
+              write_attribute(column_name, Time.now)
+            end
+          end
+        end
+      end
+    end
+
+    # module InstanceMethods
+    # end
+  end
+end

data/lib/date_checkbox/version.rb

@@ -0,0 +1,21 @@
+# vim:ft=ruby:fileencoding=utf-8
+
+module DateCheckbox
+  VERSION = '0.0.1'
+  DATE = File.mtime(__FILE__)
+
+  SUMMARY = 'Rails-plugin to create a checkbox for datetime-attributes.'
+  DESCRIPTION = <<-EOD
+    This is a rails-plugin which can create a checkbox for attributes which are
+    datetime-fields in the database. So, if you want to store the date when a user
+    appected some terms or received some goods, but want to circumvent the need of
+    selecting the proper date and time from 6 dropdowns, you can just use this
+    plugin.
+
+    It creates some wrapper-methods on the model for the attributes you specify and
+    provides a form-helper which uses these. The model-method also work with
+    standard checkbox-tags
+  EOD
+
+  EXTRA_RDOC_FILES = ['README.rdoc']
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require 'date_checkbox'

data/test/all.rb

@@ -0,0 +1,3 @@
+Dir[File.expand_path('../*_test.rb', __FILE__)].each do |file|
+  require file
+end

data/test/database.yml

@@ -0,0 +1,22 @@
+sqlite:
+  :adapter: sqlite
+  :dbfile: db/date_checkbox_plugin.sqlite.db
+ 
+sqlite3:
+  :adapter: sqlite3
+  :dbfile: db/date_checkbox_plugin.sqlite3.db
+ 
+postgresql:
+  :adapter: postgresql
+  :username: postgres
+  :password: postgres
+  :database: date_checkbox_plugin_test
+  :min_messages: ERROR
+ 
+mysql:
+  :adapter: mysql
+  :host: localhost
+  :username: root
+  :password: password
+  :database: date_checkbox_plugin_test
+

data/test/date_checkbox_test.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+
+class DateCheckboxTest < ActiveSupport::TestCase
+  # implementation and infratructure details
+  test "schema is loaded" do
+    assert_equal [], PublishedAtPost.all
+  end
+
+  # test "a module with the formtag exists" do
+  #   flunk
+  # end
+
+  # test "the formtag-module is mixed into tha default formbuilder" do
+  #   flunk
+  # end
+
+  # test "the formtag-method is available" do
+  #   flunk
+  # end
+end

data/test/form_helper_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+class DateCheckboxFormHelperTest < ActiveSupport::TestCase
+  test "form-helpers include the the date_checkbox-helper" do
+    assert_respond_to instance, :date_checkbox
+    assert_equal -2, instance.method(:date_checkbox).arity
+  end
+
+  test "helper outputs a checkbox" do
+    assert_nothing_raised(Exception) do
+      result = instance.date_checkbox :published_at
+      assert_equal "check_box published", result
+
+      result = instance.date_checkbox :published
+      assert_equal "check_box published", result
+    end
+  end
+
+  test "helper output the info after the checkbox" do
+    assert_nothing_raised(Exception) do
+      instance = instance(:published_at => Time.now)
+      result = instance.date_checkbox :published_at
+      assert_match(/^check_box published\d{4}-\d{2}-\d{2}$/, result)
+
+      result = instance.date_checkbox :published
+      assert_match(/^check_box published\d{4}-\d{2}-\d{2}$/, result)
+    end
+  end
+
+  def klass
+    @klass ||= Class.new() do
+      include DateCheckbox::FormHelper
+
+      attr_reader :object
+
+      def initialize(object_args = {})
+        @object = PublishedAtPost.new(object_args)
+      end
+
+      def check_box(sym)
+        "check_box #{sym}"
+      end
+    end
+  end
+
+  def instance(object_args = {})
+    @instance ||= klass.new(object_args)
+  end
+end

data/test/has_date_checkbox_test.rb

@@ -0,0 +1,66 @@
+require 'test_helper'
+
+class HasDateCheckboxTest < ActiveSupport::TestCase
+  def teardown
+    @klass = nil
+    @instance = nil
+  end
+
+  test "a class method for one field is added" do
+    assert_respond_to klass, :has_date_checkbox
+    assert_equal 1, klass.method(:has_date_checkbox).arity
+  end
+
+  test "has_date_checkbox defines a custom reader for the given attribute" do
+    assert_respond_to instance, :published
+    assert_respond_to instance, :published?
+  end
+
+  test "returns something falsish when attribute is not set" do
+    instance.published_at = nil
+    assert_equal false, instance.published?
+    assert_equal '0', instance.published
+    # assert_equal I18n.t(:not_published), instance.published
+  end
+
+  test "returns something trueish when attribute is set" do
+    instance.published_at = 1.minute.ago
+    assert_equal true,  instance.published?
+    assert_equal '1', instance.published
+    # assert_equal I18n.t(:is_published), instance.published
+  end
+
+  test "has_date_checkbox defines a custom writer for the given attribute" do
+    assert_respond_to instance, :'published='
+  end
+
+  test "can be reset to 'not yet'" do
+    instance.published = "0"
+    assert !instance.published?
+  end
+
+  test "can be set to 'right now'" do
+    instance.published = "1"
+    assert instance.published?
+  end
+
+  test "works with update_attributes" do
+    assert !instance.published?
+    instance.update_attributes!({:published => "1"})
+    assert instance.published?
+    instance.update_attributes!({:published => "0"})
+    assert !instance.published?
+  end
+
+  protected
+
+  def klass
+    @klass ||= Class.new do
+      include DateCheckbox::HasDateCheckbox
+    end
+  end
+
+  def instance
+    @instance ||= PublishedAtPost.new
+  end
+end

data/test/schema.rb

@@ -0,0 +1,10 @@
+# vendor/plugins/date_checkbox/test/schema.rb
+
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :published_at_posts, :force => true do |t|
+    t.string :name
+    t.datetime :published_at
+    t.timestamps
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,40 @@
+ENV['RAILS_ENV'] = 'test'
+ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) + '/../../../..'
+
+require 'test/unit'
+require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb'))
+
+def load_schema
+  config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+  ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+
+  db_adapter = ENV['DB']
+
+  # no db passed, try one of these fine config-free DBs before bombing.
+  db_adapter ||=
+    begin
+      require 'rubygems'
+      require 'sqlite'
+      'sqlite'
+    rescue MissingSourceFile
+      begin
+        require 'sqlite3'
+        'sqlite3'
+      rescue MissingSourceFile
+      end
+    end
+
+  if db_adapter.nil?
+    raise "No DB Adapter selected. Pass the DB= option to pick one, or install Sqlite or Sqlite3."
+  end
+
+  ActiveRecord::Base.establish_connection(config[db_adapter])
+  load(File.dirname(__FILE__) + "/schema.rb")
+  require File.dirname(__FILE__) + '/../init'
+end
+
+load_schema
+
+class PublishedAtPost < ActiveRecord::Base
+  has_date_checkbox :published_at
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification 
+name: date_checkbox
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Matthias Viehweger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-14 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 4
+        - 2
+        version: 2.4.2
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sdoc
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: "    This is a rails-plugin which can create a checkbox for attributes which are\n    datetime-fields in the database. So, if you want to store the date when a user\n    appected some terms or received some goods, but want to circumvent the need of\n    selecting the proper date and time from 6 dropdowns, you can just use this\n    plugin.\n\n    It creates some wrapper-methods on the model for the attributes you specify and\n    provides a form-helper which uses these. The model-method also work with\n    standard checkbox-tags\n"
+email: kronn@kronn.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- TODO
+- date_checkbox.gemspec
+- install.rb
+- lib/date_checkbox.rb
+- lib/date_checkbox/form_helper.rb
+- lib/date_checkbox/has_date_checkbox.rb
+- lib/date_checkbox/version.rb
+- rails/init.rb
+- test/all.rb
+- test/database.yml
+- test/date_checkbox_test.rb
+- test/form_helper_test.rb
+- test/has_date_checkbox_test.rb
+- test/schema.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/kronn/date_checkbox
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=utf-8
+- --fmt=shtml
+- --all
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: "[none]"
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Rails-plugin to create a checkbox for datetime-attributes.
+test_files: 
+- test/all.rb
+- test/database.yml
+- test/date_checkbox_test.rb
+- test/form_helper_test.rb
+- test/has_date_checkbox_test.rb
+- test/schema.rb
+- test/test_helper.rb