graphql-relay 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 263e38a956354abcb55e391c5bdd4b43367179db
-  data.tar.gz: ab2a35a584890faac7dac968c6c003ae5386168c
+  metadata.gz: 5fb50f9e3030be285c1be81b0f0e302919a49c2f
+  data.tar.gz: fd869d0de9f2f47085c12e94c093a0ca791ee004
 SHA512:
-  metadata.gz: 2ec4c12612f83c3cfc806a1c8906aef9030354cb54701e5889eca89de0e9b02f75143feebaabc6e5779bf8e5c41fe3fa666f22ec7bcc5f8f286ed59d13b8e813
-  data.tar.gz: 90be05474c434fcdc4e8ec367e592ed063c0d66fe920e9d1dc7962f5643d8a2b73b1d0c71f4f3afc61175ea5f71d53c6b357a2eb88809b3a71a6b7907484a93d
+  metadata.gz: 68734a2849039b20d4fcfe57855217247aebbf47c3252a22b96993e26880f0f4b739f41c75c203ce32fcf4e5e15d7b0c0a2b3f2f447ae838a21f6abfaf6617f2
+  data.tar.gz: c76dd82ddc3eef84a26fd1ab949b9e4483d9d2c81ea6c41e1c08497fc900c0b476b55b2d157b8091aab1906f438317822c1f4718f56b1eec00f11d54e62f8e5f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Robert Mosolgo
+
+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/README.md

@@ -198,8 +198,6 @@ First, define the custom connection:
 ```ruby
 class SetConnection < BaseConnection
   # derive a cursor from `item`
-  # (it is used to find next & previous nodes,
-  # so it should include `order`)
   def cursor_from_node(item)
     # ...
   end
@@ -344,10 +342,10 @@ https://medium.com/@gauravtiwari/graphql-and-relay-on-rails-first-relay-powered-
 
 ## Todo
 
-- Allow custom defined ID scheme
 - Allow custom edge fields (per connection type)
 - `GlobalNodeIdentification.to_global_id` should receive the type name and _object_, not `id`. (Or, maintain the "`type_name, id` in, `type_name, id` out" pattern?)
 - Make GlobalId a property of the schema, not a global
+- Reduce duplication in ArrayConnection / RelationConnection
 
 ## More Resources
 

data/lib/graphql/relay/array_connection.rb

@@ -1,13 +1,9 @@
 module GraphQL
   module Relay
     class ArrayConnection < BaseConnection
-      # Just to encode data in the cursor, use something that won't conflict
-      CURSOR_SEPARATOR = "---"
-
       def cursor_from_node(item)
-        idx = sliced_nodes.find_index(item)
-        cursor_parts = [(order || "none"), idx]
-        Base64.strict_encode64(cursor_parts.join(CURSOR_SEPARATOR))
+        idx = starting_offset + sliced_nodes.find_index(item) + 1
+        Base64.strict_encode64(idx.to_s)
       end
 
       private
@@ -16,10 +12,7 @@ module GraphQL
       def paged_nodes
         @paged_nodes = begin
           items = sliced_nodes
-          limit = [first, last, max_page_size].compact.min
-          first && items = items.first(limit)
-          last && items.length > last && items.last(limit)
-          items
+          items.first(limit)
         end
       end
 
@@ -27,22 +20,43 @@ module GraphQL
       def sliced_nodes
         @sliced_nodes ||= begin
           items = object
-          if order
-            # Remove possible direction marker:
-            order_name = order.sub(/^-/, '')
-            items = items.sort_by { |item| item.public_send(order_name) }
-            order.start_with?("-") && items = items.reverse
-          end
-          after && items = items[(1 + index_from_cursor(after))..-1]
-          before && items = items[0..(index_from_cursor(before) - 1)]
-          items
+          items[starting_offset..-1]
         end
       end
 
       def index_from_cursor(cursor)
-        decoded = Base64.decode64(cursor)
-        order, index = decoded.split(CURSOR_SEPARATOR)
-        index.to_i
+        Base64.decode64(cursor).to_i
+      end
+
+      def starting_offset
+        @starting_offset = if before
+          [previous_offset, 0].max
+        else
+          previous_offset
+        end
+      end
+
+      def previous_offset
+        @initial_offset ||= if before
+          index_from_cursor(before) - last - 1
+        elsif after
+          index_from_cursor(after)
+        else
+          0
+        end
+      end
+
+      def limit
+        @limit ||= if first
+          [first, max_page_size].compact.min
+        else
+          last_limit = if previous_offset <= 0
+            previous_offset + last
+          else
+            last
+          end
+          [last_limit, max_page_size].compact.min
+        end
       end
     end
     BaseConnection.register_connection_implementation(Array, ArrayConnection)

data/lib/graphql/relay/connection_field.rb

@@ -12,7 +12,6 @@ module GraphQL
           [:after, GraphQL::STRING_TYPE],
           [:last, GraphQL::INT_TYPE],
           [:before, GraphQL::STRING_TYPE],
-          [:order, GraphQL::STRING_TYPE],
         ]
 
       DEFAULT_ARGUMENTS = ARGUMENT_DEFINITIONS.reduce({}) do |memo, arg_defn|
@@ -31,8 +30,7 @@ module GraphQL
       # @return [GraphQL::Field] A field which serves a connections
       def self.create(underlying_field, max_page_size: nil)
         underlying_field.arguments = DEFAULT_ARGUMENTS.merge(underlying_field.arguments)
-        # TODO: make a public API on GraphQL::Field to expose this proc
-        original_resolve = underlying_field.instance_variable_get(:@resolve_proc)
+        original_resolve = underlying_field.resolve_proc
         underlying_field.resolve = get_connection_resolve(underlying_field.name, original_resolve, max_page_size: max_page_size)
         underlying_field
       end

data/lib/graphql/relay/relation_connection.rb

@@ -1,16 +1,9 @@
 module GraphQL
   module Relay
     class RelationConnection < BaseConnection
-      DEFAULT_ORDER = "id"
-
       def cursor_from_node(item)
-        order_value = item.public_send(order_name)
-        cursor_parts = [order, order_value]
-        Base64.strict_encode64(cursor_parts.join(CURSOR_SEPARATOR))
-      end
-
-      def order
-        @order ||= (super || DEFAULT_ORDER)
+        offset = starting_offset + paged_nodes_array.index(item) + 1
+        Base64.strict_encode64(offset.to_s)
       end
 
       def has_next_page
@@ -26,12 +19,9 @@ module GraphQL
 
       # apply first / last limit results
       def paged_nodes
-        @paged_nodes = begin
+        @paged_nodes ||= begin
           items = sliced_nodes
-          limit = [first, last, max_page_size].compact.min
-          first && items = items.first(limit)
-          last && items.count > last && items = items.last(limit)
-          items
+          items.limit(limit)
         end
       end
 
@@ -39,61 +29,51 @@ module GraphQL
       def sliced_nodes
         @sliced_nodes ||= begin
           items = object
-
-          if order
-            items = items.order(items.table[order_name].public_send(order_direction))
-          end
-
-          if after
-            _o, order_value = slice_from_cursor(after)
-            direction_marker = order_direction == :asc ? ">" : "<"
-            where_condition = create_order_condition(table_name, order_name, order_value, direction_marker)
-            items = items.where(where_condition)
-          end
-
-          if before
-            _o, order_value = slice_from_cursor(before)
-            direction_marker = order_direction == :asc ? "<" : ">"
-            where_condition = create_order_condition(table_name, order_name, order_value, direction_marker)
-            items = items.where(where_condition)
-          end
-
-          items
+          items.offset(starting_offset)
         end
       end
 
-      def slice_from_cursor(cursor)
-        decoded = Base64.decode64(cursor)
-        order, order_value = decoded.split(CURSOR_SEPARATOR)
+      def offset_from_cursor(cursor)
+        Base64.decode64(cursor).to_i
       end
 
-      # Remove possible direction marker:
-      def order_name
-        @order_name ||= order.sub(/^-/, '')
-      end
-
-      # Check for direction marker
-      def order_direction
-        @order_direction ||= order.start_with?("-") ? :desc : :asc
+      def starting_offset
+        @initial_offset ||= begin
+          if before
+            [previous_offset, 0].max
+          else
+            previous_offset
+          end
+        end
       end
 
-      def table_name
-        @table_name ||= object.table.table_name
+      # Offset from the previous selection, if there was one
+      # Otherwise, zero
+      def previous_offset
+        @previous_offset ||= if after
+          offset_from_cursor(after)
+        elsif before
+          offset_from_cursor(before) - last - 1
+        else
+          0
+        end
       end
 
-      # When creating the where constraint, cast the value to correct column data type so
-      # active record can send it in correct format to db
-      def create_order_condition(table, column, value, direction_marker)
-        table_name = ActiveRecord::Base.connection.quote_table_name(table)
-        name = ActiveRecord::Base.connection.quote_column_name(column)
-        if ActiveRecord::VERSION::MAJOR == 5
-          casted_value = object.table.able_to_type_cast? ? object.table.type_cast_for_database(column, value) : value
-        elsif ActiveRecord::VERSION::MAJOR == 4 && ActiveRecord::VERSION::MINOR >= 2
-          casted_value = object.table.engine.columns_hash[column].cast_type.type_cast_from_user(value)
+      def limit
+        @limit ||= if first
+          [first, max_page_size].compact.min
         else
-          casted_value = object.table.engine.columns_hash[column].type_cast(value)
+          last_limit = if previous_offset <= 0
+            previous_offset + last
+          else
+            last
+          end
+          [last_limit, max_page_size].compact.min
         end
-        ["#{table_name}.#{name} #{direction_marker} ?", casted_value]
+      end
+
+      def paged_nodes_array
+        @paged_nodes_array ||= paged_nodes.to_a
       end
     end
 

data/lib/graphql/relay/version.rb

@@ -1,5 +1,5 @@
 module GraphQL
   module Relay
-    VERSION = '0.8.1'
+    VERSION = '0.9.0'
   end
 end

data/spec/graphql/relay/array_connection_spec.rb

@@ -11,9 +11,9 @@ describe GraphQL::Relay::ArrayConnection do
   end
   describe "results" do
     let(:query_string) {%|
-      query getShips($first: Int, $after: String, $last: Int, $before: String, $order: String, $nameIncludes: String){
+      query getShips($first: Int, $after: String, $last: Int, $before: String, $nameIncludes: String){
         rebels {
-          ships(first: $first, after: $after, last: $last, before: $before, order: $order, nameIncludes: $nameIncludes) {
+          ships(first: $first, after: $after, last: $last, before: $before, nameIncludes: $nameIncludes) {
             edges {
               cursor
               node {
@@ -48,33 +48,23 @@ describe GraphQL::Relay::ArrayConnection do
     end
 
     it 'slices the result' do
-      result = query(query_string, "first" => 3)
-      assert_equal(["X-Wing", "Y-Wing", "A-Wing"], get_names(result))
+      result = query(query_string, "first" => 1)
+      assert_equal(["X-Wing"], get_names(result))
 
       # After the last result, find the next 2:
       last_cursor = get_last_cursor(result)
 
       result = query(query_string, "after" => last_cursor, "first" => 2)
-      assert_equal(["Millenium Falcon", "Home One"], get_names(result))
-
-      result = query(query_string, "before" => last_cursor, "last" => 2)
-      assert_equal(["X-Wing", "Y-Wing"], get_names(result))
-    end
-
-    it 'paginates with order' do
-      result = query(query_string, "first" => 2, "order" => "name")
-      assert_equal(["A-Wing", "Home One"], get_names(result))
+      assert_equal(["Y-Wing", "A-Wing"], get_names(result))
 
       # After the last result, find the next 2:
-      last_cursor = result["data"]["rebels"]["ships"]["edges"].last["cursor"]
+      last_cursor = get_last_cursor(result)
 
-      result = query(query_string, "after" => last_cursor, "first" => 2, "order" => "name")
-      assert_equal(["Millenium Falcon", "X-Wing"], get_names(result))
-    end
+      result = query(query_string, "after" => last_cursor, "first" => 2)
+      assert_equal(["Millenium Falcon", "Home One"], get_names(result))
 
-    it 'paginates with reverse order' do
-      result = query(query_string, "first" => 2, "order" => "-name")
-      assert_equal(["Y-Wing", "X-Wing"], get_names(result))
+      result = query(query_string, "before" => last_cursor, "last" => 2)
+      assert_equal(["X-Wing", "Y-Wing"], get_names(result))
     end
 
     it 'applies custom arguments' do
@@ -83,7 +73,7 @@ describe GraphQL::Relay::ArrayConnection do
       assert_equal(2, names.length)
 
       after = get_last_cursor(result)
-      result = query(query_string, "nameIncludes" => "Wing", "after" => after)
+      result = query(query_string, "nameIncludes" => "Wing", "after" => after, "first" => 3)
       names = get_names(result)
       assert_equal(1, names.length)
     end

data/spec/graphql/relay/page_info_spec.rb

@@ -15,9 +15,9 @@ describe GraphQL::Relay::PageInfo do
   }
 
   let(:query_string) {%|
-    query getShips($first: Int, $after: String, $last: Int, $before: String, $order: String, $nameIncludes: String){
+    query getShips($first: Int, $after: String, $last: Int, $before: String, $nameIncludes: String){
       empire {
-        bases(first: $first, after: $after, last: $last, before: $before, order: $order, nameIncludes: $nameIncludes) {
+        bases(first: $first, after: $after, last: $last, before: $before, nameIncludes: $nameIncludes) {
           edges {
             cursor
           }

data/spec/graphql/relay/relation_connection_spec.rb

@@ -12,9 +12,9 @@ describe GraphQL::Relay::RelationConnection do
 
   describe "results" do
     let(:query_string) {%|
-      query getShips($first: Int, $after: String, $last: Int, $before: String, $order: String, $nameIncludes: String){
+      query getShips($first: Int, $after: String, $last: Int, $before: String,  $nameIncludes: String){
         empire {
-          bases(first: $first, after: $after, last: $last, before: $before, order: $order, nameIncludes: $nameIncludes) {
+          bases(first: $first, after: $after, last: $last, before: $before, nameIncludes: $nameIncludes) {
             ... basesConnection
           }
         }
@@ -58,27 +58,16 @@ describe GraphQL::Relay::RelationConnection do
       assert_equal(["Headquarters"], get_names(result))
 
       last_cursor = get_last_cursor(result)
+
       result = query(query_string, "before" => last_cursor, "last" => 1)
       assert_equal(["Shield Generator"], get_names(result))
 
       result = query(query_string, "before" => last_cursor, "last" => 2)
       assert_equal(["Death Star", "Shield Generator"], get_names(result))
-    end
-
-    it 'paginates with reverse order' do
-      result = query(query_string, "first" => 2, "order" => "-name")
-      assert_equal(["Shield Generator", "Headquarters"], get_names(result))
-    end
-
-    it 'paginates with order' do
-      result = query(query_string, "first" => 2, "order" => "name")
-      assert_equal(["Death Star", "Headquarters"], get_names(result))
 
-      # After the last result, find the next 2:
-      last_cursor = get_last_cursor(result)
+      result = query(query_string, "before" => last_cursor, "last" => 10)
+      assert_equal(["Death Star", "Shield Generator"], get_names(result))
 
-      result = query(query_string, "after" => last_cursor, "first" => 2, "order" => "name")
-      assert_equal(["Shield Generator"], get_names(result))
     end
 
     it "applies custom arguments" do
@@ -138,7 +127,7 @@ describe GraphQL::Relay::RelationConnection do
     let(:query_string) {%|
       {
         empire {
-          basesClone {
+          basesClone(first: 10) {
             edges {
               node {
                 name
@@ -154,12 +143,12 @@ describe GraphQL::Relay::RelationConnection do
     end
   end
 
-  describe "overriding default order" do
+  describe "custom ordering" do
     let(:query_string) {%|
       query getBases {
         empire {
-          basesByName { ... basesFields }
-          bases { ... basesFields }
+          basesByName(first: 30) { ... basesFields }
+          bases(first: 30) { ... basesFields }
         }
       }
       fragment basesFields on BaseConnection {

data/spec/support/star_wars_schema.rb

@@ -87,6 +87,13 @@ Faction = GraphQL::ObjectType.define do
   connection :basesClone, BaseType.connection_type
   connection :basesByName, BaseType.connection_type, property: :bases do
     argument :order, types.String, default_value: "name"
+    resolve -> (obj, args, ctx) {
+      if args[:order].present?
+        obj.bases.order(args[:order])
+      else
+        obj.bases
+      end
+    }
   end
 
   connection :basesWithMaxLimitRelation, BaseType.connection_type, max_page_size: 2 do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-relay
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Robert Mosolgo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-22 00:00:00.000000000 Z
+date: 2016-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -200,6 +200,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
 - README.md
 - lib/graphql/relay.rb
 - lib/graphql/relay/array_connection.rb