sequel-mysql_json 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 710f4deced669859204c62148fe36c3d2bcfc7ed
+  data.tar.gz: 80faad18d63ea8283daac633fc8add7927b4486b
+SHA512:
+  metadata.gz: 3ab3341f8495af5051f04db2264bc4772eec821da51922cbe5fbfcfe99c9abb353b312c94839e00340cb412b0f3ff322c7bdea1bdc675bcc3d463ce5e95829c8
+  data.tar.gz: 09247d4c9d2a2032b80f4cecd9163bdcbfcb70f3820df44a7cee17c81af2a534242c0bd050f3718e160995fbff909e97f536bbf65a05c00e47bb8d1b6d0988f3

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp
+*.swo

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sequel-mysql_json.gemspec
+gemspec

data/README.md

@@ -0,0 +1,154 @@
+# Sequel::MysqlJson
+
+Sequel extension and plugin that adds better support for MySQL JSON columns and
+functions (added first on MySQL 5.7.8).
+
+### `mysql_json` plugin
+
+`mysql_json` detects MySQL json columns on models and automatically adds column
+accessors that deserializes JSON values. Uses Sequel's builtin Serialization
+plugin for this purpose.
+
+### `mysql_json_op` extension
+
+`mysql_json_op` extension adds support to Sequel's DSL to make it easier to
+call MySQL JSON functions and operators.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sequel-mysql_json'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sequel-mysql_json
+
+
+## Usage
+
+To enable plugin for all models, call `Sequel::Model.plugin :mysql_json`.
+To enable extension, call `Sequel.extension :mysql_json_ops`.
+
+For example, suppose you have a model with a json column `metadata`, like this:
+
+```ruby
+class Thing < Sequel::Model
+  set_schema do
+    primary_key :id
+    json :metadata
+  end
+end
+
+Thing.create_table!
+```
+
+Because plugin uses the
+[Serialization](http://sequel.jeremyevans.net/rdoc-plugins/classes/Sequel/Plugins/Serialization.html)
+plugin, we can pass serializable Ruby objects, like a hash when setting the
+`metadata` column accessor.
+
+```ruby
+Thing.create(metadata: { foo: 1, bar: 2 })
+# => #<Thing @values={:id=>1, :metadata=>"{\"bar\": 2, \"foo\": 1}"}>
+
+Thing.first.metadata['foo']
+# => 1
+```
+
+To construct queries using JSON related functions, first build a `JSONOp`
+object:
+
+```ruby
+Sequel.mysql_json_op(:metadata)
+# => #<Sequel::Mysql::JSONOp @value=>:metadata>
+
+Thing.select_map(Sequel.mysql_json_op(:metadata).extract('.foo'))
+# SELECT JSON_EXTRACT(`metadata`, '$.foo') AS `v` FROM `things`
+# => ["1"]
+```
+
+As you can see the `$` prefix is appended automatically to the path selector.
+
+If you are using Sequel `core_extension` or `core_refinements`, you can also:
+
+```ruby
+Thing.select_map(:metadata.mysql_json_op.extract('.foo'))
+# SELECT JSON_EXTRACT(`metadata`, '$.foo') AS `v` FROM `things`
+# => ["1"]
+```
+
+`#[]` and `#get` are aliases of `#extract`. Also, when providing a Symbol,
+selector is converted to a path that extracts a field from a JSON object.
+Likewise, when using an Integer, path selector extracts a value from a JSON
+array:
+
+```ruby
+Thing.select_map(:metadata.mysql_json_op[:foo])
+# SELECT JSON_EXTRACT(`metadata`, '$.foo') AS `v` FROM `things`
+# => ["1"]
+
+Thing.select_map(:metadata.mysql_json_op[42])
+# SELECT JSON_EXTRACT(`metadata`, '$[1]') AS `v` FROM `things`
+# => [nil]
+```
+
+JSONOp will merge nested `#extract` calls into a single one:
+
+```ruby
+Thing.create(metadata: 5.times.map { |id| { id: id, value: "id#{id}" } })
+
+Thing.select_map(:metadata.mysql_json_op['[*]'][:value])
+# SELECT JSON_EXTRACT(`metadata`, '$[*].value') AS `v` FROM `posts`
+# => ["id0", "id1", "id2", "id3", "id4"]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/munshkr/sequel-mysql_json.
+
+
+## License
+
+MIT License
+
+Copyright (c) 2016 Damián Silvani
+
+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/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,8 @@
+#!/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/lib/sequel/extensions/mysql_json_ops.rb

@@ -0,0 +1,159 @@
+module Sequel
+  module Mysql
+    # The JSONOp class is a simple container for a single object that defines
+    # methods that yield Sequel expression objects representing MySQL json
+    # operators and functions.
+    #
+    # In the method documentation examples, assume that:
+    #
+    #   json_op = Sequel.mysql_json_op(:json)
+    #
+    class JSONOp < Sequel::SQL::Wrapper
+      SPACE_RE = /\s+/
+
+      # Extract a value as json
+      #
+      #   json_op.extract('[0]')   # JSON_EXTRACT(json, '$[0]')
+      #   json_op.extract('.a')    # JSON_EXTRACT(json, '$.a')
+      #
+      # When using an Integer, it will be used as an index of a JSON array
+      #
+      #   json_op.extract(0)        # JSON_EXTRACT(json, '$[0]')
+      #
+      # When using a Symbol, it will be used as a member of a JSON object
+      #
+      #   json_op.extract(:a)       # JSON_EXTRACT(json, '$.a')
+      #
+      def extract(key)
+        case value
+        when SQL::Function
+          # Merge path selector of a nested :extract function
+          json_op, path = value.args
+          json_op(:extract, json_op, path + path_selector(key))
+        else
+          json_op(:extract, self, "$#{path_selector(key)}")
+        end
+      end
+      alias :[]  :extract
+      alias :get :extract
+
+      # Replace values for paths that exist and add values
+      # for paths that do not exist.
+      #
+      def set(*args)
+        json_op(:set, self, *args)
+      end
+
+      # Add new values but does not replace existing values
+      #
+      def insert(*args)
+        json_op(:insert, self, *args)
+      end
+
+      # Replace existing values and ignore new values
+      #
+      def replace(*args)
+        json_op(:replace, self, *args)
+      end
+
+      # Take a JSON document and one or more paths that specify values
+      # to be removed from the document.
+      #
+      def remove(*args)
+        json_op(:remove, self, *args)
+      end
+
+      # Take two or more JSON documents and return the combined result
+      #
+      def merge(*args)
+        json_op(:merge, self, *args)
+      end
+
+      # Return the value's JSON type if it is valid and produces an error
+      # otherwise.
+      #
+      def type
+        Sequel::SQL::StringExpression.new(:NOOP, function(:type, self))
+      end
+
+      private
+
+      # Return a function wrapped in a JSONOp object
+      def json_op(*args)
+        self.class.new(function(*args))
+      end
+
+      # Return a function with the given name, and the receiver as the first
+      # argument, with any additional arguments given.
+      def function(name, *args)
+        SQL::Function.new(function_name(name), *args)
+      end
+
+      # The json type functions are prefixed with JSON_
+      def function_name(name)
+        "JSON_#{name.to_s.upcase}"
+      end
+
+      # Return a path selector based on key class
+      def path_selector(key)
+        case key
+        when Integer
+          "[#{key}]"
+        when Symbol
+          ".#{quote(key)}"
+        else
+          key
+        end
+      end
+
+      # Return quoted key if it has spaces
+      def quote(key)
+        key.to_s.index(SPACE_RE) ? "\"#{key}\"" : key
+      end
+    end
+
+    module JSONOpMethods
+      # Wrap the receiver in an JSONOp so you can easily use the MySQL
+      # json functions and operators with it.
+      def mysql_json_op
+        JSONOp.new(self)
+      end
+    end
+  end
+
+  module SQL::Builders
+    # Return the object wrapped in an Mysql::JSONOp.
+    def mysql_json_op(v)
+      case v
+      when Mysql::JSONOp
+        v
+      else
+        Mysql::JSONOp.new(v)
+      end
+    end
+  end
+
+  class SQL::GenericExpression
+    include Sequel::Mysql::JSONOpMethods
+  end
+
+  class LiteralString
+    include Sequel::Mysql::JSONOpMethods
+  end
+end
+
+# :nocov:
+if Sequel.core_extensions?
+  class Symbol
+    include Sequel::Mysql::JSONOpMethods
+  end
+end
+
+if defined?(Sequel::CoreRefinements)
+  module Sequel::CoreRefinements
+    refine Symbol do
+      include Sequel::Mysql::JSONOpMethods
+    end
+  end
+end
+# :nocov:

data/lib/sequel/plugins/mysql_json.rb

@@ -0,0 +1,14 @@
+module Sequel
+  module Plugins
+    module MysqlJson
+      module ClassMethods
+        def set_dataset(*args)
+          super
+          @db_schema.select { |_, o| o[:db_type] == 'json' }.each_key do |c|
+            plugin :serialization, :json, c
+          end
+        end
+      end
+    end
+  end
+end

data/sequel-mysql_json.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "sequel-mysql_json"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Damián Silvani"]
+  spec.email         = ["munshkr@gmail.com"]
+
+  spec.summary       = %q{Sequel extension and plugin that adds support for MySQL JSON columns.}
+  spec.description   = %q{
+    Extension adds support to Sequel's DSL to make it easier to call MySQL JSON
+    function and operators (added first on MySQL 5.7.8).
+
+    Plugin detects MySQL json columns on models and adds column accessor that
+    deserializes JSON values automatically (using Sequel's builtin Serialization
+    plugin).
+  }
+  spec.homepage      = "https://github.com/munshkr/sequel-mysql_json"
+
+  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 "minitest", "~> 5.0"
+
+  spec.add_dependency 'sequel', '>= 4'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: sequel-mysql_json
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Damián Silvani
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+description: "\n    Extension adds support to Sequel's DSL to make it easier to call
+  MySQL JSON\n    function and operators (added first on MySQL 5.7.8).\n\n    Plugin
+  detects MySQL json columns on models and adds column accessor that\n    deserializes
+  JSON values automatically (using Sequel's builtin Serialization\n    plugin).\n
+  \ "
+email:
+- munshkr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sequel/extensions/mysql_json_ops.rb
+- lib/sequel/plugins/mysql_json.rb
+- sequel-mysql_json.gemspec
+homepage: https://github.com/munshkr/sequel-mysql_json
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Sequel extension and plugin that adds support for MySQL JSON columns.
+test_files: []