active_record-framing 0.1.0.pre.2 → 0.1.0.pre.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8dd6c0a413bc426a0a22dee85cb7077ffb21c47fb77e5cf411a47478961002d1
-  data.tar.gz: 5c7b93bcd554161bf4020f5f3d3cec8882d31ec0b9da86ef26b72b08f70d146d
+  metadata.gz: 4bb54c09be5bd01b84d55f0bb8e959e5ef1a5c7f6a13d4f6ed55089f901129b1
+  data.tar.gz: 20d17ac8e31e7866148b70d2983d2941bd298e4cd9fa6e94e5756e85a52a904d
 SHA512:
-  metadata.gz: 04f3c99ff11c241b3a0915d06e4c32cf171bd31b18314ac23f7c2536ad8d35aefaac73bdcfe4cbb4c6476a04db3bfcf03fdbde902865ea8dc761671d9894efed
-  data.tar.gz: b19fcf8ef79262680551b65f0dffe47d5c0cb2b1216d5c7c149dd7d7037067f3b5785dd87d2aa6d5ce0dc8d749d440f0864a6c4360b7bf1d30273475d42f0ebb
+  metadata.gz: 8ba3bbbb8ebc8eeaabdbcabc927ed2a2358922c91286f99007a99354e38165f6f62a33c56030b2e3cf1e3457864793feed1a9277c1eacd4f52dbf55d1cf76463
+  data.tar.gz: 6dbd8f819768e3e90ce8b9777d7280fa793cbe276a9af84da4fed7ab961b4fba1cc284e7cdb337c07372c8d623d4b2c0db43f5cdc3854b74e379da0a5de85db1

data/README.md

@@ -51,15 +51,36 @@ SELECT "users".* FROM "users"
 
 ```ruby
 class Admin < User
-  default_frame('admins') { where(kind: 1) }
+  default_frame { where(arel_table[:kind].eq(1)) }
   # ...
 end
 ```
 
+Note: In `ActiveRecord` versions less than `5.2` (Arel `9.0`), `default_frames` where clauses must be constructed with `arel` (`arel_table[:column]` etc) for values other than `nil`, `true`, and `false`. This is due to a limitation with what ActiveRecord calls "bind values" (beyond the scope of this document).
+
 Afterwards, `Admin.all.to_sql` yields
 ```sql
-WITH "admins" AS
-  (SELECT "users".* )
+WITH "users" AS
+  (SELECT "users".* FROM "users" WHERE "users"."kind" = 1)
+```
+
+Similar to how `named_scopes` work in `ActiveRecord`, frames can be named:
+
+```ruby
+class User < ActiveRecord::Base
+  frame :admin, -> { where(arel_table[:kind].eq(1)) }
+  # ...
+end
+```
+
+Named frames are accessed through assigned consts under the original class. This helps avoid collision with scopes, and helps indicate the mutual exclusivity of frames (by design).
+
+```ruby
+User::Admin.all.to_sql
+# =>
+# WITH "admin/users" AS
+#   (SELECT "users".* FROM "users" WHERE "users".kind = 1)
+# SELECT "admin/users".* FROM "admin/users"
 ```
 
 ## Development

data/lib/active_record/framing/core_extension.rb

@@ -6,8 +6,8 @@ module ActiveRecord
   module Framing
 
     def self.prepended(subclass)
-      subclass.class_eval do
-        singleton_class.alias_method :unframed_all, :all
+      subclass.singleton_class.class_eval do
+        alias_method :unframed_all, :all
       end
 
       subclass.include Default

data/lib/active_record/framing/relation.rb

@@ -38,17 +38,11 @@ module ActiveRecord
           source.left.name.to_s # TODO: Need to_s?
         end
 
-        # scopes = klass.reflections.slice(*join_names).values.inject(Hash.new) do |collector, assoc|
         # NOTE: We cannot early exclude associations because some associations are different from their table names
         klass.reflect_on_all_associations.each do |assoc|
-          # collector.merge(assoc.klass.default_scopes) if join_names.include?(assoc.table_name)
-          # (collector[assoc.klass] ||= Set.new).merge(assoc.klass.default_scopes) if join_names.include?(assoc.table_name) && assoc.klass.default_scopes.any?
           if join_names.include?(assoc.table_name) && assoc.klass.default_frames.any? && assoc_default_frame = assoc.klass.send(:build_default_frame)
             merge!(assoc_default_frame)
-            # collector[assoc_default_frame.table_name] ||= assoc_default_frame
           end
-
-          # collector
         end
       end
 

data/lib/active_record/framing/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module Framing
-    VERSION = "0.1.0-2"
+    VERSION = "0.1.0-3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record-framing
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.2
+  version: 0.1.0.pre.3
 platform: ruby
 authors:
 - Dale Stevens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-08 00:00:00.000000000 Z
+date: 2019-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord