has_calculated_fields 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a813ff50e480a6825a04c5c2716584344a19f55f1fae56e44331095bb4c052ae
+  data.tar.gz: c79bab42c03712ffdda782bce4e7bcc4df0692102f7d53d1bf2a335197749bc5
+SHA512:
+  metadata.gz: c1a8034c1ceee80ba59a7878a6c5a764bf224024a63559250e2e6d2b694f1e64e59a57e86622067f954d23502bf7172d607968856f0e4f52375ec872eddc3bb4
+  data.tar.gz: 8209ea84a770f0720415f6bbbfb25e19f0e6623a6b7f9a83ccd24f84f94e572e9e9c99e1dca13b0a55d3f6dae62464d76afa94bb78625c4891e06705208280dd

data/.gitignore

@@ -0,0 +1,49 @@
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/coverage/
+/spec/tmp
+*.orig
+rerun.txt
+pickle-email-*.html
+
+# TODO Comment out this rule if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+config/master.key
+
+# Only include if you have production secrets in this file, which is no longer a Rails default
+# config/secrets.yml
+
+# dotenv
+# TODO Comment out this rule if environment variables can be committed
+.env
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalize the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv
+
+# Ignore Byebug command history file.
+.byebug_history
+
+# Ignore node_modules
+node_modules/
+

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,99 @@
+PATH
+  remote: .
+  specs:
+    has_calculated_fields (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    active_model_serializers (0.9.7)
+      activemodel (>= 3.2)
+      concurrent-ruby (~> 1.0)
+    activemodel (4.2.11.1)
+      activesupport (= 4.2.11.1)
+      builder (~> 3.1)
+    activerecord (4.2.11.1)
+      activemodel (= 4.2.11.1)
+      activesupport (= 4.2.11.1)
+      arel (~> 6.0)
+    activesupport (4.2.11.1)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (6.0.4)
+    ast (2.4.0)
+    builder (3.2.3)
+    byebug (11.0.1)
+    concurrent-ruby (1.1.5)
+    database_cleaner (1.7.0)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    factory_bot (4.11.1)
+      activesupport (>= 3.0.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    json (2.2.0)
+    minitest (5.11.3)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (2.2.2)
+      rake
+    rake (12.3.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rubocop (0.49.1)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.10.1)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sqlite3 (1.3.13)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_model_serializers (~> 0.9.3)
+  activerecord (= 4.2.11.1)
+  appraisal (~> 2.2)
+  byebug
+  database_cleaner
+  factory_bot (~> 4.8)
+  has_calculated_fields!
+  rspec (~> 3.6)
+  rubocop (~> 0.49.1)
+  simplecov (~> 0.15.0)
+  sqlite3 (~> 1.3.6)
+
+BUNDLED WITH
+   1.16.6

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+
+desc "Run specs"
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Default: run specs."
+task default: :spec

data/has_calculated_fields.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "has_calculated_fields"
+  s.version     = "1.0.0"
+  s.platform    = Gem::Platform::RUBY
+  s.author      = ["Adrian Fernandez"]
+  s.email       = ["adrianfernandez85@gmail.com"]
+  s.homepage    = "http://github.com/adrian-fernandez/has_calculated_fields"
+  s.summary     = "Rails gem to allow models to save auto calculated fields"
+  s.description = "Rails gem to allow models to save auto calculated fields"
+  s.license     = "MIT"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec", "~> 3.6"
+  s.add_development_dependency "activerecord", "4.2.11.1"
+  s.add_development_dependency "sqlite3", "~> 1.3.6"
+  s.add_development_dependency "rubocop", "~> 0.49.1"
+  s.add_development_dependency "simplecov", "~> 0.15.0"
+  s.add_development_dependency "appraisal", "~> 2.2"
+  s.add_development_dependency "byebug"
+  s.add_development_dependency "factory_bot", "~> 4.8"
+  s.add_development_dependency "database_cleaner"
+  s.add_development_dependency "active_model_serializers", "~> 0.9.3"
+
+end

data/lib/has_calculated_fields.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "active_support/inflector"
+require "active_model_serializers"
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+module HasCalculatedFields
+  if defined?(ActiveRecord::Base)
+    require "has_calculated_fields/has_calculated_fields"
+
+    ActiveRecord::Base.extend HasCalculatedFields
+  end
+end

data/lib/has_calculated_fields/has_calculated_fields.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module HasCalculatedFields
+  module HasCalculatedFields
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def has_calculated_fields(args = {})
+        define_method :has_calculated_fields_options do
+          self.class.instance_variable_get("@has_calculated_fields_options")
+        end
+
+        class_eval do
+          @has_calculated_fields_options = { }.merge(args)
+
+          def self.has_calculated_fields?
+            true
+          end
+        end
+      end
+    end
+
+    included do
+      before_save :_has_calculated_fields__on_before_save
+    end
+
+    def _has_calculated_fields__on_before_save
+      return unless has_calculated_fields_options.has_key?(:on_before_save)
+
+      has_calculated_fields_options[:on_before_save].each do |data|
+        attr_equal = "#{data[:calculated_field]}="
+
+        value = case data[:type]
+                when :date
+                  if data[:format]
+                    I18n.l(_has_calculated_fields__field_value(data), format: data[:format])
+                  else
+                    I18n.l(_has_calculated_fields__field_value(data))
+                  end
+                when :method
+                  data[:method].call(self)
+        end
+
+        send(attr_equal, value)
+      end
+    end
+
+    def _has_calculated_fields__field_value(data)
+      field = data.fetch(:field, nil)
+      if field.present?
+        send(field) || _has_calculated_fields__default_field_value(data)
+      else
+        _has_calculated_fields__default_field_value(data)
+      end
+    end
+
+    def _has_calculated_fields__default_field_value(data)
+      value = data.fetch(:default, nil)
+      case value
+      when :now
+        Time.current
+      when :nil
+        nil
+      else
+        value
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, HasCalculatedFields::HasCalculatedFields)

data/spec/factories/other_event.rb

@@ -0,0 +1,6 @@
+#frozen_string_literal: true
+
+FactoryBot.define do
+  factory :sample_model do
+  end
+end

data/spec/has_calculated_fields_spec.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+require "byebug"
+
+describe HasCalculatedFields do
+  describe "runs before_save callbacks" do
+    let(:name) { "name" }
+    let(:created_at) { Time.find_zone("Madrid").parse("2019-05-03 2pm") }
+    let(:obj) { create(:sample_model, created_at: created_at, name: name) }
+
+    context "using time" do
+      context "when attribute has value" do
+        it "assigns formatted time attribute" do
+          new_date = Time.find_zone("Madrid").parse("2019-05-04 4pm")
+
+          obj.created_at = new_date
+          expect { obj.save }.to change { obj.calculated_created_at }
+            .from("Fri, 03 May 2019 14:00:00 +0200")
+            .to("Sat, 04 May 2019 16:00:00 +0200")
+        end
+      end
+
+      context "when attribute hasn't value" do
+        let(:created_at) { nil }
+        it "assigns formatted time attribute" do
+          expect { obj.save }.to change { obj.calculated_created_at }
+            .from(I18n.l(Time.current))
+            .to(I18n.l(Time.current.in_time_zone("UTC")))
+        end
+      end
+    end
+
+    context "using method" do
+      it "assigns new value to the calculated attribute" do
+        obj.name = "new name"
+
+        expect { obj.save }.to change { obj.calculated_name }
+          .from("name calculated!")
+          .to("new name calculated!")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), "..", "lib")
+require "sqlite3"
+require "has_calculated_fields"
+require "factory_bot"
+require 'database_cleaner'
+require "active_model_serializers"
+
+Dir["./spec/support/**/*.rb"].sort.each { |f| require f }
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.around(:each) do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end
+  end
+end
+
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+
+ActiveRecord::Schema.define(version: 1) do
+  create_table :sample_models do |t|
+    t.string :name
+    t.datetime :created_at
+
+    t.string :calculated_name
+    t.string :calculated_created_at
+  end
+end
+
+class SampleModel < ActiveRecord::Base
+  has_calculated_fields on_before_save: [
+    {
+      calculated_field: :calculated_created_at,
+      field: :created_at,
+      type: :date,
+      default: :now
+    },
+    {
+      calculated_field: :calculated_name,
+      type: :method,
+      method: Proc.new do |obj|
+        obj.name + " calculated!"
+      end
+    }
+  ]
+end

data/spec/support/factory_bot.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
+
+  config.before(:suite) do
+    FactoryBot.find_definitions
+  end
+end

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: has_calculated_fields
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Adrian Fernandez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.11.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.11.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+description: Rails gem to allow models to save auto calculated fields
+email:
+- adrianfernandez85@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- has_calculated_fields.gemspec
+- lib/.DS_Store
+- lib/has_calculated_fields.rb
+- lib/has_calculated_fields/.DS_Store
+- lib/has_calculated_fields/has_calculated_fields.rb
+- spec/.DS_Store
+- spec/factories/other_event.rb
+- spec/has_calculated_fields_spec.rb
+- spec/spec_helper.rb
+- spec/support/factory_bot.rb
+homepage: http://github.com/adrian-fernandez/has_calculated_fields
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.7.8
+signing_key: 
+specification_version: 4
+summary: Rails gem to allow models to save auto calculated fields
+test_files:
+- spec/factories/other_event.rb
+- spec/has_calculated_fields_spec.rb
+- spec/spec_helper.rb
+- spec/support/factory_bot.rb