mobility 0.0.1 → 0.1.0

data/lib/mobility/translates.rb

@@ -0,0 +1,75 @@
+module Mobility
+=begin
+
+Defines methods for attaching backends to a class. A block can optionally be
+passed to accessors to configure backend (see example below).
+
+@example Defining backend on a class
+  class MyClass
+    extend Translates
+    mobility_accessor :foo, option1: :value
+  end
+
+@example Passing backend to a block
+  class MyClass
+    extend Translates
+    mobility_accessor :foo, option1: :value do |backend|
+      # do something with backend
+    end
+  end
+
+@example Defining only a backend reader and presence method
+  class MyClass
+    extend Translates
+    mobility_reader :foo
+  end
+
+  instance = MyClass.new
+  instance.foo         #=> (some value)
+  instance.foo?        #=> true
+  instance.foo = "foo" #=> NoMethodError
+
+@example Defining only a backend writer
+  class MyClass
+    extend Translates
+    mobility_writer :foo
+  end
+
+  instance = MyClass.new
+  instance.foo         #=> NoMethodError
+  instance.foo?        #=> NoMethodError
+  instance.foo = "foo" #=> (sets attribute to value "foo")
+=end
+  module Translates
+    # Defines mobility accessor on model class.
+    # @param [Array<String>] attributes
+    # @param [Hash] options
+    # @yield [Object] Backend
+    # @!method mobility_accessor(*attributes, **options)
+
+    # Defines mobility reader and presence method on model class.
+    # @param [Array<String>] attributes
+    # @param [Hash] options
+    # @yield [Object] Backend
+    # @!method mobility_reader(*attributes, **options)
+
+    # Defines mobility writer on model class.
+    # @param [Array<String>] attributes
+    # @param [Hash] options
+    # @yield [Object] Backend
+    # @!method mobility_writer(*attributes, **options)
+    %w[accessor reader writer].each do |method|
+      class_eval <<-EOM, __FILE__, __LINE__ + 1
+        def mobility_#{method}(*args, **options)
+          attributes = Attributes.new(:#{method}, *args, options.merge(model_class: self))
+          yield(attributes.backend) if block_given?
+          attributes.each do |attribute|
+            alias_method "\#{attribute}_before_mobility",  attribute        if method_defined?(attribute)        && #{%w[accessor reader].include? method}
+            alias_method "\#{attribute}_before_mobility=", "\#{attribute}=" if method_defined?("\#{attribute}=") && #{%w[accessor writer].include? method}
+           end
+          include attributes
+        end
+      EOM
+    end
+  end
+end

data/lib/mobility/wrapper.rb

@@ -0,0 +1,31 @@
+module Mobility
+=begin
+
+Class to access Mobility across backends. In particular, keeps a record of
+which {Attributes} modules have been included on the model class. It is also a
+simple delegator, so any missing method will be delegated to the model class.
+
+=end
+  class Wrapper < SimpleDelegator
+    # @return [Array<Attributes>]
+    attr_reader :modules
+    alias :model_class :__getobj__
+
+    # @param [Class] model_class Model class
+    def initialize(model_class)
+      super
+      @modules = []
+    end
+
+    # @return [Array<String>] Translated attributes defined on model
+    def translated_attribute_names
+      modules.map(&:attributes).flatten
+    end
+
+    # Appends backend module to +modules+ array for later reference.
+    # @param [Attributes] backend_module Attributes module
+    def << backend_module
+      modules << backend_module
+    end
+  end
+end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: mobility
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Chris Salzberg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-03 00:00:00.000000000 Z
+date: 2017-02-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.10
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,25 +94,124 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: Stores and retrieves localized data through attributes on a Ruby class,
+  with flexible support for different storage strategies.
 email:
 - chris@dejimata.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
 - Gemfile
+- Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
+- lib/generators/mobility/install_generator.rb
+- lib/generators/mobility/templates/create_string_translations.rb
+- lib/generators/mobility/templates/create_text_translations.rb
 - lib/mobility.rb
+- lib/mobility/active_model.rb
+- lib/mobility/active_model/attribute_methods.rb
+- lib/mobility/active_model/backend_resetter.rb
+- lib/mobility/active_record.rb
+- lib/mobility/active_record/backend_resetter.rb
+- lib/mobility/active_record/model_translation.rb
+- lib/mobility/active_record/string_translation.rb
+- lib/mobility/active_record/text_translation.rb
+- lib/mobility/active_record/translation.rb
+- lib/mobility/attributes.rb
+- lib/mobility/backend.rb
+- lib/mobility/backend/active_model.rb
+- lib/mobility/backend/active_model/dirty.rb
+- lib/mobility/backend/active_record.rb
+- lib/mobility/backend/active_record/column.rb
+- lib/mobility/backend/active_record/column/query_methods.rb
+- lib/mobility/backend/active_record/hash_valued.rb
+- lib/mobility/backend/active_record/hstore.rb
+- lib/mobility/backend/active_record/hstore/query_methods.rb
+- lib/mobility/backend/active_record/jsonb.rb
+- lib/mobility/backend/active_record/jsonb/query_methods.rb
+- lib/mobility/backend/active_record/key_value.rb
+- lib/mobility/backend/active_record/key_value/query_methods.rb
+- lib/mobility/backend/active_record/query_methods.rb
+- lib/mobility/backend/active_record/serialized.rb
+- lib/mobility/backend/active_record/serialized/query_methods.rb
+- lib/mobility/backend/active_record/table.rb
+- lib/mobility/backend/active_record/table/query_methods.rb
+- lib/mobility/backend/cache.rb
+- lib/mobility/backend/column.rb
+- lib/mobility/backend/dirty.rb
+- lib/mobility/backend/fallbacks.rb
+- lib/mobility/backend/hstore.rb
+- lib/mobility/backend/jsonb.rb
+- lib/mobility/backend/key_value.rb
+- lib/mobility/backend/null.rb
+- lib/mobility/backend/orm_delegator.rb
+- lib/mobility/backend/sequel.rb
+- lib/mobility/backend/sequel/column.rb
+- lib/mobility/backend/sequel/column/query_methods.rb
+- lib/mobility/backend/sequel/dirty.rb
+- lib/mobility/backend/sequel/hash_valued.rb
+- lib/mobility/backend/sequel/hstore.rb
+- lib/mobility/backend/sequel/hstore/query_methods.rb
+- lib/mobility/backend/sequel/jsonb.rb
+- lib/mobility/backend/sequel/jsonb/query_methods.rb
+- lib/mobility/backend/sequel/key_value.rb
+- lib/mobility/backend/sequel/key_value/query_methods.rb
+- lib/mobility/backend/sequel/query_methods.rb
+- lib/mobility/backend/sequel/serialized.rb
+- lib/mobility/backend/sequel/serialized/query_methods.rb
+- lib/mobility/backend/sequel/table.rb
+- lib/mobility/backend/sequel/table/query_methods.rb
+- lib/mobility/backend/serialized.rb
+- lib/mobility/backend/table.rb
+- lib/mobility/backend_resetter.rb
+- lib/mobility/configuration.rb
+- lib/mobility/core_ext/nil.rb
+- lib/mobility/core_ext/object.rb
+- lib/mobility/core_ext/string.rb
+- lib/mobility/instance_methods.rb
+- lib/mobility/orm.rb
+- lib/mobility/sequel.rb
+- lib/mobility/sequel/backend_resetter.rb
+- lib/mobility/sequel/column_changes.rb
+- lib/mobility/sequel/model_translation.rb
+- lib/mobility/sequel/string_translation.rb
+- lib/mobility/sequel/text_translation.rb
+- lib/mobility/sequel/translation.rb
+- lib/mobility/translates.rb
 - lib/mobility/version.rb
-- mobility.gemspec
+- lib/mobility/wrapper.rb
 homepage: 
 licenses:
 - MIT
@@ -83,7 +224,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -94,6 +235,5 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: Pluggable translation framework for Ruby on Rails.
+summary: Pluggable Ruby translation framework
 test_files: []
-has_rdoc: 

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.rspec

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

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.2.3
-before_install: gem install bundler -v 1.12.5

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "mobility"
-
-# 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

data/bin/setup

@@ -1,8 +0,0 @@
-#!/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/mobility.gemspec

@@ -1,32 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'mobility/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "mobility"
-  spec.version       = "0.0.1"
-  spec.authors       = ["Chris Salzberg"]
-  spec.email         = ["chris@dejimata.com"]
-
-  spec.summary       = %q{Pluggable translation framework for Ruby on Rails.}
-#  spec.homepage      = "TODO: Put your gem's website or public repo URL here."
-  spec.license       = "MIT"
-
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-#    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
-  end
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-end