wharel 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cc08c38afc3848972e34af95c8251bf82c8b2cdf753a97a72b6114413cb8c95
-  data.tar.gz: 49fddc078c65170e7f9b67b81efde57f7de81235d6793a7d410cb6aae6bbc824
+  metadata.gz: 6f1a415500f1ace6b7dd7ef92e229fd7d4586bb540c205cc70bddf0658b76484
+  data.tar.gz: 9f0368d29226dc719e46a9e6ec33e2499f2d9b1926c76b16654d2003a8270b78
 SHA512:
-  metadata.gz: abe42c838ceb0c5d785501fe719ca702e5f9a973fc6b84af176775123f0bdd47c7a2101ecd39d4317202f47ee1af8101e110ed9294b5f73fc9371f9c7a2280e1
-  data.tar.gz: dead1e758bd94c11b02a3be8ff623a13e8d058610b9f2dd1fa88d8063dfbdf219ada4814ce21be1c0bd444366f09c79240e0e3e849196d69d2034a176a4959de
+  metadata.gz: '04528bf9b9fd6d710c779c477e180f496738b8a390ceea7ce9f5c315a9ace364bad3177dfe3120e36df2fdeb0d384d5e01e95a2706b3b985ab48d3a9eed9c393'
+  data.tar.gz: 922b8917d0c62596b2c693efcda21c77cb84d9fa599c5cc75a232dce82f11beda1939199abafdacbdddbacfd8d7f874d18a0928d6e906aa4db49097d0e22e98d

data/Gemfile

@@ -4,3 +4,5 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in wharel.gemspec
 gemspec
+
+gem 'pry-byebug'

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    wharel (0.1.0)
-      activerecord (~> 5.2)
+    wharel (0.0.1)
+      activerecord (~> 5.0)
 
 GEM
   remote: https://rubygems.org/
@@ -19,11 +19,21 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     arel (9.0.0)
+    byebug (10.0.2)
+    coderay (1.1.2)
     concurrent-ruby (1.0.5)
+    database_cleaner (1.7.0)
     diff-lcs (1.3)
     i18n (1.0.1)
       concurrent-ruby (~> 1.0)
+    method_source (0.9.0)
     minitest (5.11.3)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -38,6 +48,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
+    sqlite3 (1.3.13)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
@@ -47,8 +58,11 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.16)
+  database_cleaner
+  pry-byebug
   rake (~> 10.0)
   rspec (~> 3.0)
+  sqlite3
   wharel!
 
 BUNDLED WITH

data/README.md

@@ -1,8 +1,18 @@
 # Wharel
 
-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/wharel`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Wharel helps you write concise Arel queries with ActiveRecord using Virtual
+Rows inspired by
+[Sequel](http://sequel.jeremyevans.net/rdoc/files/doc/virtual_rows_rdoc.html).
+
+Although similar in spirit to gems like
+[Squeel](https://github.com/activerecord-hackery/squeel) and
+[BabySqueel](https://github.com/rzane/baby_squeel), which provide sophisticated
+block-based interfaces for querying with Arel, Wharel is much much smaller. In
+fact, the core of the gem is only [25 lines
+long](https://github.com/shioyama/wharel/blob/master/lib/wharel.rb)! It uses a
+single `BasicObject` as a [clean
+room](https://www.sethvargo.com/the-cleanroom-pattern/) to evaluate
+the query block. That's really all there is to it.
 
 ## Installation
 
@@ -22,13 +32,64 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Suppose we have a model `Post`:
+
+```ruby
+class Post < ApplicationRecord
+  has_many :comments
+end
+```
+
+And let's assume our `Post` has columns `title` and `content`.
+
+Now, if we wanted to find all the posts with a title which matched the string
+"foo" and content which matched the string "bar", we'd have to resort to
+something like this:
+
+```ruby
+title = Post.arel_table[:title]
+content = Post.arel_table[:content]
+Post.where(title.matches("foo").and(content.matches("bar")))
+```
+
+With Wharel, you can drop the boilerplate and just use a block:
+
+```ruby
+Post.where { title.matches("foo").and(content.matches("bar")) }
+```
 
-## Development
+Wharel will map `title` and `content` in the block to the appropriate Arel
+attribute for the column.
 
-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.
+Now suppose we have another model `Comment` with a column `content`, and a
+`Post` `has_many :comments`:
+
+```ruby
+class Post < ApplicationRecord
+  has_many :comments
+end
+
+class Comment < ApplicationRecord
+  belongs_to :post
+end
+```
+
+Now we want to find all comments which match the title of the comment's post.
+With standard Arel, you could do this with:
+
+```ruby
+posts = Post.arel_table
+comments = Comment.arel_table
+Comment.joins(:post).where(comments[:content].matches(posts[:title]))
+```
+
+Using Wharel, you can pass an argument to blocks to handle this case:
+
+```ruby
+Comment.joins(:post).where { |c| Post.where { |p| c.content.matches(p.title) } }
+```
 
-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).
+Much better!
 
 ## Contributing
 

data/lib/wharel/version.rb

@@ -1,3 +1,3 @@
 module Wharel
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wharel
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Chris Salzberg
@@ -88,6 +88,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Use arel predicates directly from where.
 email:
 - chris@dejimata.com

metadata.gz.sig

@@ -1 +1 @@
-$ˢ����03S%f�N,�	=̕���x�X�C�{��(�S�c����g�=���h�ϵ��b��.�D9
+0G���9���u�����R�Y�?O5����ti����X�L����((d�>��XX3����@�?;�j�X�Ĭ�}#���2�����,;�����vB���囘�;G���+�