roqua-support 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0d83dcfdd5a8666dbfa15efa42dc41bc1286944
-  data.tar.gz: f4c169d8f8b96e4b578e4808c7212b0cb2ee1495
+  metadata.gz: 04157f293aa088264645c6571535bbff47532f96
+  data.tar.gz: a77b44d28bc6c0604aacbff2d9f3f6d983a0e03e
 SHA512:
-  metadata.gz: a11b436cc2a870c201ec997a5e23f6d47148b54d9ce5978fc08b5ef248db4382de8e2d2c9b440085249b3b978123bb6bb21d7db3b41995f93d2a9777c0687069
-  data.tar.gz: 5de99e2f313f6c21e70f938db3d79ad0533dc025006cc8f57d6e8d69adb18a4ffd1917bb2adbf97cd3fb53137ac188df88c8d01126ed81201ed3fa51196bdce4
+  metadata.gz: a4afb549cb7124a21623c25144917a4ddf8d1f771da44aa10bf61b1fb342205f1ee34663c9124191b164a9071d9293afb956fd10c5ca40168756f7f34105571c
+  data.tar.gz: 2316b715438c76b82f7a9e8820eb029122c16d749396c4545df2611705587de49f69e18476eab21d0a242d604112f089feefeff5c6ae58285da8e6bbbb0615ee

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.12 / 2014-11-10
+
+* Added roqua/core_ext/active_interaction/filters/date_time_as_unix_extension that allows date_times attributes to be set by a unix timestamp.
+* Added roqua/core_ext/active_interaction/filters/duration_filter that allows ActiveSupport::Duration attributes.
+
 ## 0.1.11 / 2014-11-06
 
 * Don't catch Mysql2 errors

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    roqua-support (0.1.11)
+    roqua-support (0.1.12)
       activesupport (>= 3.2, < 5.0)
 
 GEM

data/README.md

@@ -76,6 +76,30 @@ class ApiAreaController < ApplicationController
   ...
 ```
 
+### ActiveInteraction extensions
+
+```
+require 'roqua/core_ext/active_interaction/filters/date_time_as_unix_extension'
+```
+
+Allows a date or date_time attribute to be set by a unix time e.g. 1415608242 or '1415608242'.
+
+
+```
+require 'roqua/core_ext/active_interaction/filters/duration_filter'
+
+class DurationFilterOperation < ActiveInteraction::Base
+  duration :duration
+  duration :foo, strip: true, default: nil # value is nil if duration is 0.
+end
+
+DurationFilterOperation.run(duration: 1.week)
+DurationFilterOperation.run(duration: {value: 1, unit: 'weeks'})
+```
+
+Allows you to specify an ActiveSupport::Duration attribute.
+
+
 ## Contributing
 
 1. Fork it

data/lib/roqua-support/version.rb

@@ -1,5 +1,5 @@
 module Roqua
   module Support
-    VERSION = '0.1.11'
+    VERSION = '0.1.12'
   end
 end

data/lib/roqua/core_ext/active_interaction/filters/date_time_as_unix_extension.rb

@@ -0,0 +1,29 @@
+# allow datetimes to be given as unix times for activeinteractions
+module RoquaDateTimeAsUnixFilterExtension
+  def cast(value)
+    case value
+    when Numeric, /^[0-9]+$/
+      Time.at(value.to_i).to_datetime
+    when ''
+      super(nil)
+    else
+      super
+    end
+  end
+end
+ActiveInteraction::DateTimeFilter.include RoquaDateTimeAsUnixFilterExtension
+
+# allow datetimes to be given as unix times as string
+module RoquaTimeAsUnixFilterExtension
+  def cast(value)
+    case value
+    when /^[0-9]+$/
+      Time.at(value.to_i)
+    when ''
+      super(nil)
+    else
+      super
+    end
+  end
+end
+ActiveInteraction::TimeFilter.include RoquaTimeAsUnixFilterExtension

data/lib/roqua/core_ext/active_interaction/filters/duration_filter.rb

@@ -0,0 +1,46 @@
+I18n.backend.store_translations :en, active_interaction: {
+  types: { duration: 'Duration' }
+}
+
+module ActiveInteraction
+  class Base
+    # @!method self.duration(*attributes, options = {})
+    #   Creates accessors for the attributes and ensures that the value passed to
+    #     the attributes is a  ActiveSupport::Duration.
+    #   Value can be a hash with a value and unit key
+    #
+    #   @!macro filter_method_params
+    #   @option options [Boolean] :strip (false) Make nil if value is 0.
+    #
+    #   @example
+    #     duration :first_name
+    #   @example
+    #     duration :first_name, strip: true
+  end
+
+  # @private
+  class DurationFilter < Filter
+    register :duration
+
+    def cast(value)
+      case value
+      when ActiveSupport::Duration
+        (value == 0 && strip?) ? super(nil) : value
+      when Hash
+        if value[:value].present? && (value[:value].to_i != 0 || !strip?)
+          value[:value].to_i.send(value[:unit])
+        else
+          super(nil)
+        end
+      else
+        super
+      end
+    end
+
+    private
+
+    def strip?
+      options.fetch(:strip, false)
+    end
+  end
+end

data/spec/roqua/core_ext/active_interaction/date_time_as_unix_extension_spec.rb

@@ -0,0 +1,51 @@
+require 'active_interaction'
+require 'active_support/all'
+require 'roqua/core_ext/active_interaction/filters/date_time_as_unix_extension'
+
+class DateTimeFilterOperation < ActiveInteraction::Base
+  date_time :date_time, default: nil
+
+  def execute
+    date_time
+  end
+end
+
+describe RoquaDateTimeAsUnixFilterExtension do
+  let(:time) { Time.now.change(:usec => 0) }
+
+  it 'unix integer time translates correctly to datetime' do
+    expect(DateTimeFilterOperation.run! date_time: time.to_i).to eq time
+  end
+
+  it 'unix integer time as string translates correctly to datetime' do
+    expect(DateTimeFilterOperation.run! date_time: time.to_i.to_s).to eq time
+  end
+
+  it 'transations and empty string to nil' do
+    expect(DateTimeFilterOperation.run! date_time: '').to eq nil
+  end
+end
+
+class TimeFilterOperation < ActiveInteraction::Base
+  time :time, default: nil
+
+  def execute
+    time
+  end
+end
+
+describe RoquaDateTimeAsUnixFilterExtension do
+  let(:time) { Time.now.change(:usec => 0) }
+
+  it 'unix integer time translates correctly to time' do
+    expect(TimeFilterOperation.run! time: time.to_i).to eq time
+  end
+
+  it 'unix integer time as string translates correctly to datetime' do
+    expect(TimeFilterOperation.run! time: time.to_i.to_s).to eq time
+  end
+
+  it 'transations and empty string to nil' do
+    expect(TimeFilterOperation.run! time: '').to eq nil
+  end
+end

data/spec/roqua/core_ext/active_interaction/duration_filter_spec.rb

@@ -0,0 +1,90 @@
+require 'active_interaction'
+require 'active_support/all'
+require 'roqua/core_ext/active_interaction/filters/duration_filter'
+
+class DurationFilterOperation < ActiveInteraction::Base
+  duration :duration
+  duration :stripped_duration, strip: true, default: nil
+
+  def execute
+    {duration: duration, stripped_duration: stripped_duration}
+  end
+end
+
+describe ActiveInteraction::DurationFilter do
+  let(:duration) { 1.week }
+  let(:stripped_duration) { 1.week }
+
+
+  subject { DurationFilterOperation.run!(duration: duration, stripped_duration: stripped_duration) }
+
+  describe 'when given a duration object' do
+    it 'receives the object correctly' do
+      expect(subject[:duration]).to be_a(ActiveSupport::Duration)
+      expect(subject[:duration]).to eq 1.week
+    end
+
+    it 'does not strip non-0 values' do
+      expect(subject[:stripped_duration]).to be_a(ActiveSupport::Duration)
+      expect(subject[:stripped_duration]).to eq 1.week
+    end
+  end
+
+  describe 'when given a 0 duration object' do
+    let(:duration) { 0.weeks }
+    let(:stripped_duration) { 0.weeks }
+
+    it 'receives the object correctly' do
+      expect(subject[:duration]).to be_a(ActiveSupport::Duration)
+      expect(subject[:duration]).to eq 0.weeks
+    end
+
+    it 'strips 0 values' do
+      expect(subject[:stripped_duration]).to eq nil
+    end
+  end
+
+  describe 'when given a hash object' do
+    let(:duration) { {value: '1', unit: 'weeks'} }
+    let(:stripped_duration) { {value: '1', unit: 'weeks'} }
+
+    it 'receives the object correctly' do
+      expect(subject[:duration]).to be_a(ActiveSupport::Duration)
+      expect(subject[:duration]).to eq 1.week
+    end
+
+    it 'does not strip non-0 values' do
+      expect(subject[:stripped_duration]).to be_a(ActiveSupport::Duration)
+      expect(subject[:stripped_duration]).to eq 1.week
+    end
+  end
+
+  describe 'when given a hash {value: "0"} object' do
+    let(:duration) { {value: '0', unit: 'weeks'} }
+    let(:stripped_duration) { {value: '0', unit: 'weeks'} }
+
+    it 'receives the object correctly' do
+      expect(subject[:duration]).to be_a(ActiveSupport::Duration)
+      expect(subject[:duration]).to eq 0.weeks
+    end
+
+    it 'strips 0 values' do
+      expect(subject[:stripped_duration]).to eq nil
+    end
+  end
+
+  describe 'when given a hash {value: ""} object' do
+    let(:duration) { {value: '', unit: 'weeks'} }
+
+    it 'throws a required error when not stripped' do
+      expect { subject }.to raise_error ActiveInteraction::InvalidInteractionError, 'Duration is required'
+    end
+  end
+
+  describe 'when given a hash {value: ""} object' do
+    let(:stripped_duration) { {value: '', unit: 'weeks'} }
+    it 'strips 0 values' do
+      expect(subject[:stripped_duration]).to eq nil
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roqua-support
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Marten Veldthuis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-06 00:00:00.000000000 Z
+date: 2014-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -97,6 +97,8 @@ files:
 - circle.yml
 - lib/roqua-support.rb
 - lib/roqua-support/version.rb
+- lib/roqua/core_ext/active_interaction/filters/date_time_as_unix_extension.rb
+- lib/roqua/core_ext/active_interaction/filters/duration_filter.rb
 - lib/roqua/core_ext/activerecord/uniq_find_or_create.rb
 - lib/roqua/core_ext/array/stable_sort_by.rb
 - lib/roqua/core_ext/enumerable/sort_by_alphanum.rb
@@ -111,6 +113,8 @@ files:
 - lib/roqua/support/logging.rb
 - lib/roqua/support/request_logger.rb
 - roqua-support.gemspec
+- spec/roqua/core_ext/active_interaction/date_time_as_unix_extension_spec.rb
+- spec/roqua/core_ext/active_interaction/duration_filter_spec.rb
 - spec/roqua/core_ext/activerecord/uniq_find_or_create_spec.rb
 - spec/roqua/core_ext/array/stable_sort_by_spec.rb
 - spec/roqua/core_ext/enumerable/sort_by_alphanum_spec.rb
@@ -143,11 +147,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: Helper objects and proxies used by a lot of RoQua applications
 test_files:
+- spec/roqua/core_ext/active_interaction/date_time_as_unix_extension_spec.rb
+- spec/roqua/core_ext/active_interaction/duration_filter_spec.rb
 - spec/roqua/core_ext/activerecord/uniq_find_or_create_spec.rb
 - spec/roqua/core_ext/array/stable_sort_by_spec.rb
 - spec/roqua/core_ext/enumerable/sort_by_alphanum_spec.rb
@@ -160,3 +166,4 @@ test_files:
 - spec/roqua/support/request_logger_spec.rb
 - spec/roqua/support_spec.rb
 - spec/spec_helper.rb
+has_rdoc: