mobility_typed 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d488719d610215bf72bd49b82b0a817780278e3dffdd9d400b308774a7b67688
+  data.tar.gz: '068e0a7f91c31411978574d9c5acd61f724384789ad013dfc2bef0d97a9ff413'
+SHA512:
+  metadata.gz: 9a0bb4e7f952c28d6d113968627584a7ef9f8512243a4e8fcc5771ee09ba650a62bba1c41a2efc3ca9fe1ac500766e16e79690d65e293c1ed3df1f952c7da662
+  data.tar.gz: 626e7d6abd6d5d613583010c16ea5adcde6e5bdbc340ce0a37ad455f4e2d9c7f5505ada90db817e07fb03574d4ed292334d42af28c30c10b08ad9459b9a3c0ad

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mobility.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    mobility_typed (0.1)
+      mobility (~> 1.1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    concurrent-ruby (1.2.2)
+    diff-lcs (1.5.0)
+    i18n (1.13.0)
+      concurrent-ruby (~> 1.0)
+    mobility (1.1.3)
+      i18n (>= 0.6.10, < 2)
+      request_store (~> 1.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    rack (3.0.7)
+    rainbow (3.1.1)
+    rake (10.5.0)
+    regexp_parser (2.8.0)
+    request_store (1.5.1)
+      rack (>= 1.4)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (0.89.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.3.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.8.0)
+      parser (>= 2.7.1.5)
+    rubocop-rspec (1.40.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (1.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  mobility_typed!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.89.0)
+  rubocop-rspec (~> 1.40.0)
+
+BUNDLED WITH
+   1.17.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 GeorgeGorbanev
+
+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,119 @@
+# Mobility. Typed.
+
+This gem contains plugin for [Mobility](https://github.com/shioyama/mobility) translation framework. 
+It provides type checking for attribute writers.
+
+## Motivation
+
+Since Mobility supports different storage backends some of them will not
+guarantee type safety of input data. For example Postgres
+([`Mobility::Backend::Jsonb`](http://www.rubydoc.info/gems/mobility/Mobility/Backends/Jsonb)
+let us to save any kind of json-based data in single column.
+
+```ruby
+class Offer < ApplicationRecord
+  # ...
+   
+  translates :benefits
+end
+
+Offer.create!(benefits: ['fast', 'safe'])
+Offer.create!(benefits: 'cheap')
+
+Offer.find_each do |offer|
+  offer.benefits.each { |benefit| Customer.notify_by_benefit(benefit) }
+  # => NoMethodError (undefined method `each' for "cheap":String)
+end
+```
+
+To prevent errors like this or at least detect them earlier we can add
+`:type` option to attribute writer configuration:
+
+```ruby
+class Offer < ApplicationRecord
+  # ...
+   
+  translates :benefits, writer: { type: :array }
+end
+
+Offer.create!(benefits: ['fast', 'safe'])
+Offer.create!(benefits: 'cheap')
+# => MobilityTyped::Writer::TypeError ("benefits= called with string, array expected")
+# now error exposed before database records was corrupted
+# so we can fix it earlier and code below will executes safely 
+Offer.find_each do |offer|
+  offer.benefits.each { |benefit| Customer.notify_by_benefit(benefit) }
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mobility_typed'
+```
+
+And then execute:
+
+```sh
+$ bundle install
+```
+
+Then add plugin to your mobility initializer:
+
+```ruby
+# your_rails_app/config/initializers/mobility.rb
+Mobility.configure do
+  # ...
+  plugins do
+    # ...
+    typed_writer
+    # ...
+  end
+  # ...
+end
+```
+And remove `writer` plugin from your model if you have it:
+
+```ruby
+Mobility.configure do
+  # ...
+    plugins do
+      # ...
+        writer # <---- remove this line
+      # ...
+    end
+  # ...
+end
+```
+
+## Usage
+
+Just add `type` option to attribute writer configuration:
+
+```ruby
+class YourModel < ApplicationRecord
+  translates :your_attribute, writer: { type: :integer }
+end
+```
+
+List of available writers types:
+1) `:string`
+2) `:integer`
+3) `:float`
+4) `:bool`
+5) `:array`
+6) `:hash`
+
+## Default Mobility::Plugins::Writer compatibility
+
+To use `typed_writer` plugin you should remove `writer` plugin from your initializer. 
+But `typed_writer` plugin is backward compatible with `writer` plugin. You can translate attributes 
+without passing `type` option to writer configuration. In this case `typed_writer` will work just as `writer` plugin.
+
+
+## TODO:
+
+1) Type checking for nested attributes, to check `array` and `hash` content
+2) RBS generator

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task(:default).clear.enhance(%w[spec rubocop])

data/lib/mobility_typed/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module MobilityTyped
+  VERSION = '0.1'
+
+  def self.gem_version
+    Gem::Version.new(VERSION)
+  end
+end

data/lib/mobility_typed/writer.rb

@@ -0,0 +1,69 @@
+# frozen-string-literal: true
+
+require 'mobility'
+
+module MobilityTyped
+  module Writer
+    TYPES_MAP = {
+      String => :string,
+      Integer => :integer,
+      Float => :float,
+      TrueClass => :bool,
+      FalseClass => :bool,
+      Array => :array,
+      Hash => :hash
+    }.freeze
+
+    class TypeError < StandardError; end
+
+    extend Mobility::Plugin
+
+    default true
+    requires :backend
+
+    initialize_hook do |*names|
+      if options[:typed_writer]
+        type_option = options[:typed_writer][:type] if options[:typed_writer].is_a?(Hash)
+
+        names.each do |name|
+          class_eval <<-EOM, __FILE__, __LINE__ + 1
+            def #{name}=(value, locale: nil, **options)
+              #{MobilityTyped::Writer.check_type(name, type_option) if type_option}
+              #{MobilityTyped::Writer.setup_source}
+              mobility_backends[:#{name}].write(locale, value, **options)
+            end
+          EOM
+        end
+      end
+    end
+
+    def self.setup_source
+      <<-EOL
+        return super(value) if options[:super]
+        if (locale &&= locale.to_sym)
+          #{'Mobility.enforce_available_locales!(locale)' if I18n.enforce_available_locales}
+          options[:locale] = true
+        else
+          locale = Mobility.locale
+        end
+      EOL
+    end
+
+    def self.check_type(name, type)
+      <<-EOL
+      if !value.nil? 
+        value_type = MobilityTyped::Writer.value_type(value)
+        if value_type != :#{type}        
+          raise MobilityTyped::Writer::TypeError, "#{name}= called with \#{value_type}, #{type} expected"
+        end
+      end
+      EOL
+    end
+
+    def self.value_type(value)
+      TYPES_MAP[value.class] || value.class
+    end
+
+    Mobility::Plugins.register_plugin(:typed_writer, MobilityTyped::Writer)
+  end
+end

data/lib/mobility_typed.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MobilityTyped
+  require 'mobility_typed/writer'
+end

data/mobility_typed.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mobility_typed/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mobility_typed'
+  spec.version       = MobilityTyped.gem_version
+  spec.authors       = ['George Gorbanev']
+  spec.email         = ['georgegorbanev@gmail.com']
+
+  spec.required_ruby_version = '>= 2.5'
+
+  spec.summary       = 'Ruby Mobility gem plugin designed to add type checking for translated attributes'
+  spec.description   = <<~DESCRIPTION
+    This gem adds Mobility plugin, which can be turned on for Rails model,
+    and will check types of values passed to setters.
+  DESCRIPTION
+
+  spec.homepage = 'https://github.com/georgegorbanev/mobility_typed'
+  spec.license = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/georgegorbanev/mobility_typed'
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.files = Dir['{lib/**/*,[A-Z]*}']
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'mobility', '~> 1.1.3'
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.89.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.40.0'
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: mobility_typed
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- George Gorbanev
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mobility
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.89.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.89.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.40.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.40.0
+description: |
+  This gem adds Mobility plugin, which can be turned on for Rails model,
+  and will check types of values passed to setters.
+email:
+- georgegorbanev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mobility_typed.rb
+- lib/mobility_typed/version.rb
+- lib/mobility_typed/writer.rb
+- mobility_typed.gemspec
+homepage: https://github.com/georgegorbanev/mobility_typed
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/georgegorbanev/mobility_typed
+  source_code_uri: https://github.com/georgegorbanev/mobility_typed
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+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: Ruby Mobility gem plugin designed to add type checking for translated attributes
+test_files: []