to_wa 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36cf15c4c8069cda4565d54b6f37d8cebf615f7e
-  data.tar.gz: d6f390f58ec8155f6a2cba7a226a77b8f3f47cc8
+  metadata.gz: ff02d9d70a9c571bba011ff3f651e559498cd6cd
+  data.tar.gz: 92bba9fd29b6adfd9035a16e512729bc54b6b092
 SHA512:
-  metadata.gz: 00ebf0eb142deace0e9fd90fb7d543f808704b7674950e3e5cebb199758d32096bee2991225c0978f877b20e46a7b7385f4313f76d4951afc4530c9397f35391
-  data.tar.gz: 127d4e190ed786378d95a5f87f97b4b86ffd8804fc11e8c9e42f9c17d143887a3f1c9fe40883d8e55a682eec748ca3975eadac80e119c508b1a5c982904bb2a3
+  metadata.gz: 75b7af23c3c6cf5cfb46ebd4533c9bb9bec6705e7b480b059071125bb2993fc3e7b017f1a25e5d2446ce52dd74b5916fe4bbabd3444b7f5e0eb2d2e9b17473ad
+  data.tar.gz: bea440ef0ff39602c6f265b8046ef359323f876b6b6b12a76beaabe5b8ae055953ca6b7306eca6cb27aa795845a60d6eae404de339bab05979a65e7f70fe8422

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    to_wa (0.1.0)
+    to_wa (0.2.0)
       activerecord
 
 GEM

data/README.md

@@ -1,39 +1,156 @@
+[![CircleCI](https://circleci.com/gh/mmmpa/to_wa.svg?style=svg)](https://circleci.com/gh/mmmpa/to_wa)
+
 # ToWa
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/to_wa`. To experiment with that code, run `bin/console` for an interactive prompt.
+"ToWa" adds `to_wa` method to ActiveRecord based class. `to_wa` method can receive `Hash` or `JSON` argument and add them as `Where` to ActiveRecord query.
+
+# Installation
+
+```ruby
+gem 'ToWa'
+```
 
-TODO: Delete this and the text above, and describe your gem
+```console
+bundle install
+```
 
-## Installation
+```ruby
+class TestRecord < ActiveRecord::Base
+  extend ToWa
+end
+```
 
-Add this line to your application's Gemfile:
+## Simple usage
 
 ```ruby
-gem 'to_wa'
+TestRecord.to_wa(
+  {
+    'and': [
+      { '=': ['name', 'ToWa'] },
+      { '=': ['gender', 'male'] }
+    ]
+  }
+).to_sql
+#=> "SELECT `test_records`.* FROM `test_records` WHERE (`test_records`.`name` = 'ToWa' AND `test_records`.`genderb` = 'malebbb')"
+```
+
+# Basic syntax
+
+```js
+{ "operator": valuesArray }
 ```
 
-And then execute:
+## Comparison operators
+
+They receive `[left, right]`.
 
-    $ bundle
+```js
+{ "=": ["name", "ToWa"] } // means "name eq ToWa"
+```
+
+|alias|operator||
+|:---|:---|:---|
+==|eq|
+=|eq|
+eq|eq|
+!=|not_eq|
+<>|not_eq|
+ne|not_eq|
+\>|gt|
+gt|gt|
+\>=|gteq|
+gteq|gteq|
+<|lt|
+lt|lt|
+<=|lteq|
+lteq|lteq|
+matches|matches|`right like "%right%"` (% in right will be escaped.)
+like|matches|
+in|in|`right` must be Array. `left in (right)`
+between|between|`right` must be Array. `left between right[0] and right[1]`
+
+## Logical Operators
+
+They receive data list.
+
+```js
+{
+  "and": [
+    { "=": ["name", "ToWa"] },
+    { "=": ["gender", "male"] },
+    {
+      "or": [
+        { "<": ["age", 12] },
+        { ">": ["age", 16] }
+      ]
+    }
+  ]
+} // means "(name EQ ToWa AND name EQ ToWa AND (age < 12 OR age > 16))"
+```
 
-Or install it yourself as:
+|alias|operator||
+|:---|:---|:---|
+&&|and|
+and|and|
+\|\||or|
+or|or|
+not|not|It must receive Array that includes only one data. `{ "not": [{ "name": "ToWa" }] }`
 
-    $ gem install to_wa
 
-## Usage
+# Usage
 
-TODO: Write usage instructions here
+(Ofcourse, `ActiveRecord::Relation` will be provided after `to_wa` without `to_sql`.)
 
-## Development
+```ruby
+TestRecord.to_wa({ '=': ['name', 'ToWa'] }).to_sql
+#=> SELECT `test_records`.* FROM `test_records` WHERE `test_records`.`name` = 'ToWa'
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+TestRecord.to_wa(
+  {
+    'and': [
+      { '=': ['name', 'ToWa'] },
+      { '=': ['gender', 'male'] }
+    ]
+  }
+).to_sql
+#=> "SELECT `test_records`.* FROM `test_records` WHERE (`test_records`.`name` = 'ToWa' AND `test_records`.`genderb` = 'male')"
+```
 
-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).
+```ruby
+TestRecord.to_wa(
+  {
+    'and': [
+      {
+        'or': [
+          { '=': ['name', 'ToWa'] },
+          { '=': ['name', 'to_wa'] }
+        ]
+      },
+      { '=': ['gender', 'male'] }
+    ]
+  }
+).to_sql
+#=> "SELECT `test_records`.* FROM `test_records` WHERE ((`test_records`.`name` = 'ToWa' OR `test_records`.`name` = 'to_wa') AND `test_records`.`gender` = 'male')"
+```
 
-## Contributing
+## Working with other query
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/to_wa.
+```ruby
+TestRecord.select(:id).to_wa({ '=': ['name', 'ToWa'] }).order(id: :desc).to_sql
+#=> "SELECT `test_records`.`id` FROM `test_records` WHERE `test_records`.`name` = 'ToWa' ORDER BY `test_records`.`id` DESC"
+```
 
-## License
+## Providing Arel::Nodes without ActiveRecord based class
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```ruby
+a = ToWa(Arel::Table.new('test_records'), { '=': ['name', 'ToWa'] })
+
+a.class
+#=> Arel::Nodes::Equality
+a.to_sql
+#=> "`test_records`.`name` = 'ToWa'"
+TestRecord.where(a).to_sql
+#=> "SELECT `test_records`.* FROM `test_records` WHERE `test_records`.`name` = 'ToWa'"
+```

data/lib/to_wa/builder.rb

@@ -5,24 +5,28 @@ module ToWa
     include ActiveRecord::Sanitization
 
     def to_wa(ar, ex)
-      ar.where(decide(ar, ex.is_a?(String) ? JSON.parse(ex) : ex))
+      ar.where(to_wa_raw(ar.arel_table, ex))
     end
 
-    def decide(ar, ex)
+    def to_wa_raw(arel_table = nil, ex)
+      decide(arel_table, ex.is_a?(String) ? JSON.parse(ex) : ex)
+    end
+
+    def decide(arel_table, ex)
       op = ::ToWa::Core::OPERATORS[ex.keys.first.to_s]
       values = ex.values.first
 
       case op
       when 'not'
-        decide(ar, values.first).not
+        decide(arel_table, values.first).not
       when 'and', 'or'
-        add_logic(ar, op, values)
+        add_logic(arel_table, op, values)
       else
-        add_comparison(ar, op, *values)
+        add_comparison(arel_table, op, *values)
       end
     end
 
-    def add_comparison(ar, op, table, value)
+    def add_comparison(arel_table, op, table, value)
       normalized =
         case op
         when 'between'
@@ -33,13 +37,13 @@ module ToWa
           value
         end
 
-      ar.arel_table[table].send(op, normalized)
+      arel_table[table].send(op, normalized)
     end
 
-    def add_logic(ar, op, exes)
+    def add_logic(arel_table, op, exes)
       logics =
         exes.inject(nil) do |a, ex|
-          a.nil? ? decide(ar, ex) : a.send(op, decide(ar, ex))
+          a.nil? ? decide(arel_table, ex) : a.send(op, decide(arel_table, ex))
         end
 
       (exes.size == 1) ? logics : Arel::Nodes::Grouping.new(logics)

data/lib/to_wa/version.rb

@@ -1,3 +1,3 @@
 module ToWa
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/to_wa.rb

@@ -8,10 +8,14 @@ module ToWa
   def to_wa(o)
     ::ToWa::Core.to_wa(self, o)
   end
+
+  def to_wa_raw(arel_table, o)
+    ToWa(arel_table, o)
+  end
 end
 
 module Kernel
-  def ToWa(arel_table, o)
-    ::ToWa::Core.to_wa(arel_table, o)
+  def ToWa(arel_table, o) # rubocop:disable Naming/MethodName
+    ::ToWa::Core.to_wa_raw(arel_table, o)
   end
 end

data/to_wa.gemspec

@@ -24,9 +24,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activerecord'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'database_cleaner'
   spec.add_development_dependency 'mysql2'
   spec.add_development_dependency 'onkcop'
-  spec.add_development_dependency 'database_cleaner'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: to_wa
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - mmmpa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-19 00:00:00.000000000 Z
+date: 2018-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: onkcop
+  name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: database_cleaner
+  name: onkcop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="