smarter_dates 0.2.9 → 0.2.13

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -1,4 +1,15 @@
-source 'http://rubygems.org'
+#source 'https://rubygems.org'
+source 'http://bundler-api.herokuapp.com'
+
+group :development, :test, :cucumber do
+  if RbConfig::CONFIG['RUBY_PROGRAM_VERSION'] == '1.9.3'
+    gem 'debugger'
+  elsif %w(1.9.0 1.9.1 1.9.2).include?(RbConfig::CONFIG['RUBY_PROGRAM_VERSION'])
+    gem 'ruby-debug19', require: 'ruby-debug'
+  else
+    gem 'ruby-debug'
+  end
+end
 
 # Specify your gem's dependencies in smarter_dates.gemspec
 gemspec

data/config/locales/en.yml

@@ -0,0 +1,32 @@
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  date:
+    formats:
+      default:              "%d %b %Y"
+      filesystem:           "%Y%m%d"
+      humanized_date:       "%d %b %Y"
+      mon_year:             "%b %Y"
+      humanized_date:       "%d %b %Y"
+      humanized_datetime12: "%d %b %Y"
+      humanized_datetime24: "%d %b %Y"
+
+  time:
+    formats:
+      default:              "%a %d %b %Y %H:%M:%S %z"
+      filesystem:           "%Y%m%d%H%M%S"
+      long:                 "%d %b %Y %H:%M"
+      mon_year:             "%b %Y"
+      humanized_date:       "%d %b %Y"
+      humanized_datetime12: "%d %b %Y %I:%M:%S%p"
+      humanized_datetime24: "%d %b %Y %H:%M:%S"
+
+  datetime:
+    formats:
+      default:              "%d %b %Y %H:%M:%S"
+      filesystem:           "%d%m%Y%H%M%S"
+      mon_year:             "%b %Y"
+      humanized_date:       "%d %b %Y"
+      humanized_datetime12: "%d %b %Y %I:%M:%S%p"
+      humanized_datetime24: "%d %b %Y %H:%M:%S"
+

data/lib/generators/smarter_dates/install_generator.rb

@@ -1,4 +1,6 @@
+# :nodoc:
 module SmarterDates
+  # copies configuration file for configuration.gem
   class InstallGenerator < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
 

data/lib/smarter_dates.rb

@@ -1,6 +1,11 @@
 require File.join('smarter_dates', 'version')
 require File.join('smarter_dates', 'parser')
+require File.join('smarter_dates', 'chronic_strings')
 if defined? ActiveModel
   require File.join('smarter_dates', 'chronic_parsable_validator')
 end
-
+if defined? ::Rails
+  if defined? ::Rails::Engine
+    require File.join('smarter_dates', 'engine')
+  end
+end

data/lib/smarter_dates/chronic_parsable_validator.rb

@@ -22,9 +22,7 @@ class ChronicParsableValidator < ActiveModel::EachValidator
 
   def validate_each(record, attribute, value = "") #:nodoc:
     @value = value
-    unless is_valid?
-      record.errors[attribute] << 'not a valid Date or DateTime'
-    end
+    record.errors[attribute] << 'not a valid Date or DateTime' unless is_valid?
   end
 
   # :call-seq:
@@ -42,9 +40,7 @@ class ChronicParsableValidator < ActiveModel::EachValidator
   # returns true if the string is parsable by chronic
 
   def is_valid_datetime?
-    obj = Chronic.parse(@value.respond_to?(:to_date) ?
-      @value.to_date : @value.to_s)
-    !obj.nil?
+    Chronic.parse(@value.respond_to?(:to_date) ? @value.to_date : @value.to_s)
   end
 
 end

data/lib/smarter_dates/chronic_strings.rb

@@ -0,0 +1,63 @@
+# provide natural-language date / datetime parsing to strings
+class String
+  # :call-seq:
+  # to_chronic_datetime
+  #
+  # Parses a string into a DateTime object using the Chronic gem if available.
+  # If not, try parsing the string using :parse_with_builtins
+  # raise an error if the string fails to parse
+
+  def to_chronic_datetime
+    dt = defined?(Chronic) ? parse_with_chronic : parse_with_builtins
+    #raise RuntimeError, "#{dt.inspect} unparsable Date/DateTime" unless dt
+    return unless dt
+    dt.to_datetime
+  end
+
+  # :call-seq:
+  # to_chronic_date
+  #
+  # Parses a string into a Date object using the same methods as .to_chronic_datetime
+
+  def to_chronic_date
+    obj = to_chronic_datetime
+    obj && obj.to_date
+  end
+
+  # :call-seq:
+  # to_chronic_time
+  #
+  # Parses a string into a Time object using the same methods as .to_chronic_datetime
+
+  def to_chronic_time
+    obj = to_chronic_datetime
+    obj && obj.to_time
+  end
+
+  protected
+
+  # :call-seq:
+  # parse_with_chronic
+  #
+  # attempt to parse a string with Chronic
+
+  def parse_with_chronic
+    Chronic.time_class = Time.zone
+    Chronic.parse(self)
+  end
+
+  # :call-seq:
+  # parse_with_builtins
+  #
+  # attempt to parse a string with DateTime
+  # failing that, attempt to parse a string with Date
+
+  def parse_with_builtins
+    begin
+      return DateTime.parse(self)
+    rescue
+      return Date.parse(self)
+    end
+  end
+end
+

data/lib/smarter_dates/engine.rb

@@ -0,0 +1,5 @@
+module SmarterDates
+  # integrate smarter_dates with rails
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/smarter_dates/parser.rb

@@ -2,37 +2,22 @@ require 'smarter_dates/version'
 require 'chronic'
 
 module SmarterDates
-def self.included(klass) # :nodoc:
-  attr_accessor :dt_attributes
+  def self.included(klass) # :nodoc:
+    bootstrap_smarter_dates(klass)
 
-  @dt_attributes = []
-  db_migrated = true
-  if defined?(Rails)
-    begin
-      @dt_attributes.concat(klass.column_names.select { |k| k.match(/_(?:at|on|dt|d)$/) })
-      Rails.logger.debug(RuntimeError, "unused include - #{klass.class.to_s} does not have any attributes ending in _at, _on, _dt, or _d") if db_migrated && @dt_attributes.empty?
-    rescue ActiveRecord::StatementInvalid => _
-    rescue => err
-      Rails.logger.debug(err.inspect)
+    @dt_attributes.each do |meth|
+      klass.send(:define_method, "#{meth}=".to_sym, convert_to_dt(meth))
     end
-  else
-    @dt_attributes.concat(klass.instance_methods.select { |k| k.match(/_(?:at|on|dt|d)$/) })
   end
 
   # :call-seq:
-  #   _on(string)
-  #   _at(string)
-  #   _dt(string)
-  #   _d(string)
+  # Module.convert_to_dt method
   #
-  # Any attribute ending in _at, _on, _dt, or _d are parsed by Chronic.parse
-  # (for flexibility).  Values are passed as is to Chronic.parse()
-  #
-  # == Arguments
-  # <tt>string</tt>:: A string
+  # attempts to convert using Chronic, DateTime and-or Date, whichever works first
+  # else simply yield the value
 
-  @dt_attributes.each do |k|
-    parse = Proc.new do |val|
+  def self.convert_to_dt(convert_me)
+    Proc.new do |val|
       begin
         dt = Chronic.parse(val.to_s)
       rescue
@@ -43,19 +28,93 @@ def self.included(klass) # :nodoc:
         dt = val
       end
       if defined?(Rails)
-        if dt && k.match(/_(?:on|d)$/)
-          self[k] = dt.to_date
-        elsif dt
-          self[k] = dt.to_datetime
-        else
-          self[k] = dt
-        end
+        set_rails_dt_attributes!(convert_me, dt)
       else
-        instance_variable_set(:"@#{k}", dt)
+        instance_variable_set(:"@#{convert_me}", dt)
       end
     end
-    klass.send(:define_method, "#{k}=".to_sym, &parse)
   end
-end
+
+  private
+
+  # :call-seq:
+  # Module.dt_attributes Klass
+  #
+  # Any attribute ending in _at, _on, _dt, or _d are parsed by Chronic.parse
+  # (for flexibility).  Values are passed as is to Chronic.parse()
+  #
+  # == Arguments
+  # <tt>string</tt>:: A string
+
+  def self.dt_attributes(klass)
+    klass.instance_methods.select { |meth| meth.match(/_(?:at|on|dt|d)$/) }
+  end
+
+  def self.connected? # :nodoc:
+    ActiveRecord::Base.connected?
+  end
+
+  def self.migrated? # :nodoc:
+    return unless connected?
+    ActiveRecord::Base.connection.table_exists? 'schema'
+  end
+
+  # :call-seq:
+  # Module.rails_dt_attributes Klass
+  #
+  # Any attribute ending in _at, _on, _dt, or _d are parsed by Chronic.parse
+  # (for flexibility).  Values are passed as is to Chronic.parse()
+  #
+  # == Arguments
+  # <tt>string</tt>:: A string
+
+  def self.rails_dt_attributes(klass)
+    dt_attrs = nil
+    logger = Rails.logger
+    begin
+      dt_attrs = klass.column_names.select { |meth| meth.match(/_(?:at|on|dt|d)$/) }
+      logger.debug(RuntimeError, "unused include - #{self.class.to_s} does not have any attributes ending in _at, _on, _dt, or _d") if migrated? && dt_attrs.empty?
+    rescue ActiveRecord::StatementInvalid => _
+    end
+    dt_attrs.uniq || []
+  end
+
+  # :call-seq:
+  # Module.set_rails_dt_attributes! attribute, value
+  #
+  # set attribute ending in _at, _on, _dt, or _d to date datetime
+  #
+  # == Arguments
+  # <tt>attribute</tt>:: attribute to set
+  # <tt>value</tt>:: a value
+
+  def set_rails_dt_attributes!(meth,dt)
+    if dt && meth.match(/_(?:on|d)$/)
+      write_attribute meth, dt.to_date
+    elsif dt && meth.match(/_(?:at|dt)$/)
+      write_attribute meth, dt.to_datetime
+    else
+      write_attribute meth, dt
+    end
+  end
+
+  # :call-seq:
+  # Module.bootstrap_smarter_dates class
+  #
+  # Any attribute ending in _at, _on, _dt, or _d are parsed by Chronic.parse
+  # (for flexibility).  Values are passed as is to Chronic.parse()
+  #
+  # == Arguments
+  # <tt>class</tt>:: A class to have chronically-parsed dates
+
+  def self.bootstrap_smarter_dates(klass)
+    @dt_attributes = []
+    if defined?(Rails)
+      @dt_attributes.concat(rails_dt_attributes(klass))
+    else
+      @dt_attributes.concat(dt_attributes(klass))
+    end
+  end
+
 end
 

data/lib/smarter_dates/version.rb

@@ -1,4 +1,4 @@
 module SmarterDates
-  VERSION = '0.2.9'
+  VERSION = '0.2.13'
 end
 

data/smarter_dates.gemspec

@@ -2,11 +2,28 @@
 $:.push File.expand_path('../lib', __FILE__)
 require 'smarter_dates/version'
 
+REQUIREMENTS = {
+  runtime: {
+    chronic: ['>= 0'] },
+  development: {
+    bundler: ['~> 1.3'],
+    rake: ['>= 0'],
+    sqlite3: ['>= 1.3.7'],
+    debugger: ['>= 1.5.0'],
+    rspec: ['>= 2.13.0'],
+    mocha: ['>= 0.13.0'],
+    database_cleaner: ['>= 0.9.1'],
+    machinist: ['>= 2.0.0'],
+    activerecord: ['~> 3.2.13'],
+    :'rspec-rails' => ['>= 2.12.0'] }
+}
+
 Gem::Specification.new do |spec|
   spec.name        = 'smarter_dates'
   spec.version     = SmarterDates::VERSION
   spec.authors     = ['Paul Belt']
   spec.email       = %w(paul.belt@gmail.com)
+  spec.license     = 'MIT'
   spec.homepage    = 'http://github.com/belt/smarter_dates'
   spec.summary     = %q{Natural language date processing}
   spec.description = %q{Humans want to think of date and datetime attributes in a natural manner. Standard ruby Date and DateTime objects do not support this well.}
@@ -14,25 +31,30 @@ Gem::Specification.new do |spec|
   spec.rubyforge_project = 'smarter_dates'
 
   spec.files         = `git ls-files`.split("\n")
-  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = %w(lib)
-  spec.required_ruby_version = Gem::Requirement.new('>= 1.8.7')
+
+  spec.required_ruby_version = Gem::Requirement.new('>= 1.9.2')
   spec.required_rubygems_version = Gem::Requirement.new('>= 0') if spec.respond_to? :required_rubygems_version=
 
-  if spec.respond_to? :specification_version
-    spec.specification_version = 3
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0')
-      spec.add_runtime_dependency 'chronic', ['>= 0']
-      spec.add_development_dependency 'bundler', ['~> 1.3']
-      spec.add_development_dependency 'rake', ['>= 0']
-      spec.add_development_dependency 'rails', ['>= 3.0']
-      spec.add_development_dependency 'sqlite3', ['~> 1.3.5']
-    else
-      spec.add_dependency('chronic')
+  [:runtime, :development].each do |mode|
+    REQUIREMENTS[mode].each do |req,ver|
+      if spec.respond_to? :specification_version
+        spec.specification_version = 3
+        if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0')
+          if mode == :runtime
+            spec.add_runtime_dependency req.to_s, ver
+          else
+            spec.add_development_dependency req.to_s, ver
+          end
+        else
+          spec.add_dependency req.to_s, ver
+        end
+      else
+        spec.add_dependency req.to_s, ver
+      end
     end
-  else
-    spec.add_dependency('chronic')
   end
-end
 
+end

data/spec/dummy/.gitignore

@@ -0,0 +1,2 @@
+db/*.sqlite3
+log/*.log

data/spec/dummy/.rspec

@@ -0,0 +1 @@
+--color

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.