ar_interval 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1b7fca6f5e3918ffc5b5037428c347ea57365e318752813695ad3e8ec488c202
+  data.tar.gz: 9b42b1468790a554798dc30153ede4aa9b296e8766f269b6b8172408ed7eec1b
+SHA512:
+  metadata.gz: 7411be40988916a3b52972a456c4c1d3757179cf58972bcb37535337e07ca903726fa1ade90aac2d5cc46eba52364d348190a03967832b476e5f825f870e1467
+  data.tar.gz: e03797416b55f2c45ac25a5f1846511e2e676ed57049d064ba35e22117cfbc28de95abbd5ab48ac54f90b9e46fda6f2cb988453ce8e2c58d3b76e3723d99a50e

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+test/support/config/database.yml
+tags
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ar_interval.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "pry", "~> 0.13.1"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Caleb Buxton
+
+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,75 @@
+Support for Postgres Interval Types for ActiveRecord. Currently in [Prerelease](#prerelease)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ar_interval'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ar_interval
+
+## Usage
+
+### Standalone ActiveRecord
+
+```ruby
+require 'ar_interval'
+
+class Occurence < ActiveRecord::Base
+  attribute :column_name, :interval
+end
+```
+
+#### Invalid Format as a Validation error
+
+```ruby
+require 'ar_interval'
+
+class Occurence < ActiveRecord::Base
+  include ArInterval::Validations
+
+  attribute :column_name, :interval
+end
+```
+
+### Rails
+
+TODO
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cpb/ar_interval.
+
+## Roadmap
+
+### 1.0
+
+- Default behaviour for Postgres Databases
+```ruby
+create_table :table_name do |t|
+  t.interval :column_name
+end
+```
+
+### Prerelease
+
+- Manually registered `ActiveRecord::Type`
+- Optional `ActiveSupport::Concern` providing format validations for `:interval` fields
+
+## 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,85 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => ['db:drop','db:create','db:migrate', :test]
+
+require 'pg'
+require 'active_record'
+require 'yaml'
+
+file 'test/support/config/database.yml' do |task,**kargs|
+  FileUtils.cp(task.name + '.example',task.name)
+end
+
+$:.unshift('./test/support/models')
+task :console => :database_connection do
+  require 'pry'
+  require 'occurence'
+
+  binding.pry
+end
+
+desc "Establish Database Connection"
+task :database_connection => 'test/support/config/database.yml' do
+  connection_details = YAML::load(File.open('test/support/config/database.yml'))
+  ActiveRecord::Base.establish_connection(connection_details)
+end
+
+namespace :db do
+
+  task :admin_connection => 'test/support/config/database.yml' do
+    connection_details = YAML::load(File.open('test/support/config/database.yml'))
+    ActiveRecord::Base.establish_connection(connection_details.merge({
+      'database'=> 'postgres',
+      'schema_search_path'=> 'public'
+    }))
+  end
+
+  desc "Migrate the db"
+  task :migrate => :database_connection do
+    ActiveRecord::Migrator.migrations_paths = "test/support/db/migrations"
+    ActiveRecord::Tasks::DatabaseTasks.migrate
+  end
+
+  desc "Create the db"
+  task :create => ['test/support/config/database.yml', :admin_connection] do
+    connection_details = YAML::load(File.open('test/support/config/database.yml'))
+    ActiveRecord::Base.connection.create_database(connection_details.fetch('database'))
+  end
+
+  desc "drop the db"
+  task :drop => ['test/support/config/database.yml', :admin_connection] do
+    connection_details = YAML::load(File.open('test/support/config/database.yml'))
+    ActiveRecord::Base.connection.drop_database(connection_details.fetch('database'))
+  end
+end
+
+namespace :g do
+  desc "Generate migration"
+  task :migration do
+    name = ARGV[1] || raise("Specify name: rake g:migration your_migration")
+    timestamp = Time.now.strftime("%Y%m%d%H%M%S")
+    path = File.expand_path("../test/support/db/migrations/#{timestamp}_#{name}.rb", __FILE__)
+    migration_class = name.split("_").map(&:capitalize).join
+
+    File.open(path, 'w') do |file|
+      file.write <<~EOF
+        class #{migration_class} < ActiveRecord::Migration[5.2]
+          def self.up
+          end
+          def self.down
+          end
+        end
+      EOF
+    end
+
+    puts "Migration #{path} created"
+    abort # needed stop other tasks
+  end
+end

data/ar_interval.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/ar_interval/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ar_interval"
+  spec.version       = ArInterval::VERSION
+  spec.authors       = ["Caleb Buxton"]
+  spec.email         = ["me@cpb.ca"]
+
+  spec.summary       = %q{Tools for Interval columns}
+  spec.description   = spec.summary + " for ActiveRecord"
+  spec.homepage      = "https://github.com/cpb/ar_interval/"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage + "/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", "~> 5.2"
+  spec.add_dependency "pg", "~> 1.2.3"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ar_interval"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ar_interval.rb

@@ -0,0 +1,11 @@
+require "active_record/type"
+
+require "ar_interval/version"
+require "ar_interval/type"
+require "ar_interval/validations"
+
+module ArInterval
+  class Error < StandardError; end
+  # Your code goes here...
+end
+

data/lib/ar_interval/type.rb

@@ -0,0 +1,13 @@
+module ArInterval
+  class Type < ActiveRecord::Type::Value
+    def cast(value)
+      ActiveSupport::Duration.parse(value)
+    end
+
+    def serialize(value)
+      value.iso8601
+    end
+
+    ActiveRecord::Type.register(:interval, self)
+  end
+end

data/lib/ar_interval/validations.rb

@@ -0,0 +1,34 @@
+require "active_support/concern"
+
+module ArInterval
+  module Validations
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :interval_fields
+      self.interval_fields = []
+      validate :validate_interval_fields
+    end
+
+    class_methods do
+      def attribute(name, cast_type = ActiveRecord::Attributes::Type::Value, **options)
+        case cast_type when :interval, ArInterval::Type then
+          self.interval_fields = [*self.interval_fields, name]
+        end
+
+        super
+      end
+    end
+
+    private def validate_interval_fields
+      interval_fields.each do |field|
+        field_value = read_attribute_before_type_cast(field)
+        begin
+          ActiveSupport::Duration.parse(field_value)
+        rescue ActiveSupport::Duration::ISO8601Parser::ParsingError => e
+          errors.add(field, e.message)
+        end
+      end
+    end
+  end
+end

data/lib/ar_interval/version.rb

@@ -0,0 +1,3 @@
+module ArInterval
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: ar_interval
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Caleb Buxton
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+description: Tools for Interval columns for ActiveRecord
+email:
+- me@cpb.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ar_interval.gemspec
+- bin/console
+- bin/setup
+- lib/ar_interval.rb
+- lib/ar_interval/type.rb
+- lib/ar_interval/validations.rb
+- lib/ar_interval/version.rb
+homepage: https://github.com/cpb/ar_interval/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/cpb/ar_interval/
+  source_code_uri: https://github.com/cpb/ar_interval/
+  changelog_uri: https://github.com/cpb/ar_interval//blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Tools for Interval columns
+test_files: []