json_on_rails 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 6d5cd9da9b9e15cf64d420716d697b9fdc34763d1dc4b2c5fa350bf3afdf3d6e
-  data.tar.gz: 7d9e7647696a997b94f8ed3a916cd8817e070f4d4b13dc033a23757964db1b3c
+SHA1:
+  metadata.gz: 2e69b316260dade8869a75fe7fe53189c13eb12f
+  data.tar.gz: 8ba6a935d5f718a6583fca4be7478838a4ef2254
 SHA512:
-  metadata.gz: f6fdb0645ce6d729560a9ebd71f7b87c48d4e732b723effb291ce59a3cf3714d32c21334086ca847d54187938249769d87ad0321fe698e477816d8c063cc47da
-  data.tar.gz: 93ca5c57db905354fcb8bfd6ea4b7f3dcdc85653193f28a80144c0b1edaca936426dd23b61c350bb610d7c4b031b03850a03f9de2fb2149afee73971892b844f
+  metadata.gz: 39465c73dc5ab6a33995910336add320e76b900cc5e1ba0e09c4ec2c20bb34a184d23fbeb738dc442088e15a7e4f21257d3fa4fffd42e585965f0bcf6845639c
+  data.tar.gz: 9dd50f5ecb082b355cc44c90e5c5691aac093e895c6b143f217513cc762f2edc1dca3178f04b56937606cb464a262ff545b6d42150037636e504d31b9275c6bd

data/README.md

@@ -1,5 +1,5 @@
-[![Build Status][BS img]](https://travis-ci.org/saveriomiroddi/json_on_rails)
-[![Coverage Status][CS img]](https://coveralls.io/r/saveriomiroddi/json_on_rails)
+[![Build Status](https://travis-ci.org/saveriomiroddi/json_on_rails)](https://travis-ci.org/saveriomiroddi/json_on_rails.svg?branch=master)
+[![Coverage Status](https://coveralls.io/repos/github/saveriomiroddi/json_on_rails/badge.svg?branch=master)](https://coveralls.io/github/saveriomiroddi/json_on_rails?branch=master)
 
 # JSON on Rails
 
@@ -18,7 +18,7 @@ The inner working is simple, and uses the standard Rails (internal) APIs; this i
 Add the gem to the Gemfile of your rails project:
 
 ```ruby
-gem "json_on_rails", "~> 0.1.2"
+gem "json_on_rails", "~> 0.2.0"
 ```
 
 and update the environment:
@@ -31,6 +31,13 @@ that's all!
 
 ## Usage/example
 
+Change the `mysql` connection adapter to `mysql2_json`, in `config/database.yml`:
+
+```yaml
+default: &default
+  adapter: mysql2_json
+```
+
 Create a table:
 
 ```
@@ -54,13 +61,10 @@ class CreateUsers < ActiveRecord::Migration
 end
 ```
 
-define the model:
+define the model (rails will automatically pick up the data type):
 
 ```
-class User < ActiveRecord::Base
-  attribute :extras, ActiveRecord::Type::Json.new
-end
-
+class User < ActiveRecord::Base; end
 ```
 
 then (ab)use the new attribute!:
@@ -71,9 +75,22 @@ User.create!(login: "saverio", extras: {"uses" => ["mysql", "json"]})
 User.last.extras.fetch("uses") # => ["mysql", "json"]
 ```
 
+The schema can be dumped as usual; json columns will be transparently included:
+
+```sh
+$ rake db:schema:dump
+$ cat db/schema.rb
+ActiveRecord::Schema.define(version: 0) do
+
+  create_table "users", force: :cascade do |t|
+    t.json   "extras"
+  end
+
+end
+```
+
+## Caveat/further documentation
+
 Don't forget that JSON doesn't support symbols, therefore, they can be set, but are accessed/loaded as strings.
 
 Users are encouraged to have a look at the test suite ([here](spec/json_on_rails/json_attributes_spec.rb) and [here](spec/json_on_rails/arel_methods_spec.rb)) for an exhaustive view of the functionality.
-
-[BS img]: https://travis-ci.org/saveriomiroddi/json_on_rails.svg?branch=master
-[CS img]: https://coveralls.io/repos/saveriomiroddi/json_on_rails/badge.png?branch=master

data/lib/active_record/connection_adapters/{schema_definitions.rb → abstract/json_schema_definitions.rb}

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require "active_record/connection_adapters/abstract/schema_definitions"
+
 module ActiveRecord
   # Unfortunately, the type shorthands are hardcoded, and the code itself is not encapsulated
   # in a method, so there's not much design freedom.

data/lib/active_record/connection_adapters/mysql2_json_adapter.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "active_record/connection_adapters/mysql2_adapter"
+require "active_record/type/json"
+
+# ActiveRecord resources:
+#
+#     lib/active_record/connection_adapters/mysql2_adapter.rb
+#     lib/active_record/connection_adapters/abstract_mysql_adapter.rb
+#     lib/active_record/schema_dumper.rb
+#
+# and a few other files.
+#
+module ActiveRecord
+  module ConnectionHandling
+    def mysql2_json_connection(config)
+      config = config.symbolize_keys
+
+      config[:username] = "root" if config[:username].nil?
+
+      if Mysql2::Client.const_defined? :FOUND_ROWS
+        config[:flags] = Mysql2::Client::FOUND_ROWS
+      end
+
+      client = Mysql2::Client.new(config)
+      options = [config[:host], config[:username], config[:password], config[:database], config[:port], config[:socket], 0]
+      ConnectionAdapters::Mysql2JsonAdapter.new(client, logger, options, config)
+    rescue Mysql2::Error => error
+      if error.message.include?("Unknown database")
+        raise ActiveRecord::NoDatabaseError.new(error.message, error)
+      else
+        raise
+      end
+    end
+  end
+end
+
+module ActiveRecord
+  module ConnectionAdapters
+    class Mysql2JsonAdapter < Mysql2Adapter
+      ADAPTER_NAME = "Mysql2Json".freeze
+
+      def native_database_types
+        super.merge(json: {name: "json"})
+      end
+
+      protected
+
+      def initialize_type_map(m)
+        super
+
+        m.register_type %r{json}i, Type::Json.new
+      end
+    end
+  end
+end

data/lib/active_record/type/json.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-# Resources:
+# ActiveRecord resources:
 #
-#     gems/activerecord-4.<version>/lib/active_record/attributes.rb
-#     gems/activerecord-4.<version>/lib/active_record/type/value.rb
-#     gems/activerecord-4.<version>/lib/active_record/type/mutable.rb
+#     lib/active_record/attributes.rb
+#     lib/active_record/type/value.rb
+#     lib/active_record/type/mutable.rb
 #
 module ActiveRecord
   module Type

data/lib/json_on_rails.rb

@@ -1,6 +1,4 @@
 # frozen_string_literal: true
 
-require_relative "active_record/type/json"
-require_relative "active_record/connection_adapters/schema_definitions"
-
-module JsonOnRails; end
+require_relative "active_record/connection_adapters/abstract/json_schema_definitions"
+require_relative "active_record/connection_adapters/mysql2_json_adapter"

data/lib/json_on_rails/version.rb

@@ -1,3 +1,3 @@
 module JsonOnRails
-  VERSION = "0.1.2".freeze
+  VERSION = "0.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_on_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Saverio Miroddi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-11 00:00:00.000000000 Z
+date: 2018-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.8.21
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.8.21
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -102,7 +88,8 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- lib/active_record/connection_adapters/schema_definitions.rb
+- lib/active_record/connection_adapters/abstract/json_schema_definitions.rb
+- lib/active_record/connection_adapters/mysql2_json_adapter.rb
 - lib/active_record/type/json.rb
 - lib/json_on_rails.rb
 - lib/json_on_rails/version.rb
@@ -126,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: MySQL JSON support for Rails 4