active_shotgun 0.0.2.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3abb67e7c3b8be946a8f22ed9e4c7829446b3aea28fc40e7c8bafdd1a79d063c
-  data.tar.gz: cf80eac1abcc79a182a88e8bb5850d02554cb51f7fdce66c1231c9d10b010722
+  metadata.gz: b1e2345b2533af34895ef3e5ba10ab8c161f24ad36edb318d4e101747dddeb9e
+  data.tar.gz: 39e87e5dfc26b9697094d2b826518ac9fa9a6021e24dcab684b56f08989720b1
 SHA512:
-  metadata.gz: 316e77ebbe27f4c708f8bb1849b4cb79426b79aa319cc9952e42617dedef13841fb0204612c8abed1a5a87e47052441176313945c03199fcf32d0d4beb3c7f83
-  data.tar.gz: b56bbd475751025fa8841281550ab33078bad9a88bfdc58af13157f516bb415c6db545f2286eae049694e403c1ebe0d5f575fff295bc69593d03af752a4cf7a6
+  metadata.gz: c37bf9627795d8a13f32755a0120fbe28b521b35d242e99727f3e15ceb9150b80928361f699ac4481d3f7424dea5418864e1852b957dc7285d6402d4f6f2139d
+  data.tar.gz: 2e949a1793fcd76a7cbf16fa894b9d23f5fe07eae3feaa0a035cddde61e38da69d102076df29935fd4b9b64dbc3859241e60f66a8e14cce3476424eb00e51190

data/CHANGELOG.md

@@ -6,6 +6,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.3] - 2020-12-16
+### Added
+- First version of AR complient queries. Supports:
+  - find
+  - first(number)
+  - find_by
+  - all
+  - where => Partial support. Hash only.
+  - orders
+  - limit
+  - offset
+  - select
+  - pluck
+- Behave as a Query as long as possible. Behave like an Array as soon as you look at the data.
+### Missing
+- multi-entity, entity
+- count, extra methods
+
 ## [0.0.2.1] - 2020-12-16
 ### Changed
 - Not everything is in one big file now
@@ -24,7 +42,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Gem init
 
-[Unreleased]: https://github.com/zaratan/active_shotgun/compare/v0.0.2.1...HEAD
+[Unreleased]: https://github.com/zaratan/active_shotgun/compare/v0.0.3...HEAD
+[0.0.3]: https://github.com/zaratan/active_shotgun/releases/tag/v0.0.3
 [0.0.2.1]: https://github.com/zaratan/active_shotgun/releases/tag/v0.0.2.1
 [0.0.2]: https://github.com/zaratan/active_shotgun/releases/tag/v0.0.2
 [0.0.1]: https://github.com/zaratan/active_shotgun/releases/tag/v0.0.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_shotgun (0.0.2.1)
+    active_shotgun (0.0.3)
       activemodel (>= 5.2)
       shotgun_api_ruby (>= 0.0.8.2)
       zeitwerk (~> 2)

data/lib/active_shotgun/model/read.rb

@@ -21,10 +21,41 @@ module ActiveShotgun
         end
       end
 
+      def reload
+        self.class.find(id)
+      end
+
       module ClassMethods
-        def first
-          sg_result = shotgun_client.first
-          new(sg_result.attributes.to_h.merge(id: sg_result.id))
+        def all
+          prepare_new_query.all
+        end
+
+        def limit(number)
+          prepare_new_query.limit(number)
+        end
+
+        def offset(number)
+          prepare_new_query.limit(number)
+        end
+
+        def first(number = 1)
+          prepare_new_query.first(number)
+        end
+
+        def where(conditions)
+          prepare_new_query.where(conditions)
+        end
+
+        def find_by(conditions)
+          prepare_new_query.find_by(conditions)
+        end
+
+        def orders(new_orders)
+          prepare_new_query.orders(new_orders)
+        end
+
+        def prepare_new_query
+          Query.new(type: shotgun_type, klass: self)
         end
 
         def find(id)

data/lib/active_shotgun/query.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module ActiveShotgun
+  class Query
+    def initialize(type:, klass:)
+      @type = type
+      @klass = klass
+      @conditions = nil
+      @limit = 100
+      @offset = 0
+      @orders = nil
+      @fields = nil
+    end
+
+    extend Forwardable
+    def_delegators(
+      :to_a,
+      :each
+    )
+    include Enumerable
+
+    def all
+      page_calc = format_page_from_limit_and_offset(@limit, @offset)
+      results = shotgun_client.all(
+        fields: @fields,
+        sort: @orders,
+        filter: @conditions,
+        page: page_calc[:page],
+        page_size: page_calc[:page_size]
+      )
+      results.pop(page_calc[:end_trim])
+      results.shift(page_calc[:start_trim])
+
+      results.map{ |result| @klass.new(result.attributes.to_h.merge(id: result.id)) }
+    end
+    alias_method :to_a, :all
+
+    def first(number = 1)
+      results = limit(number).all
+      if @limit == 1
+        results.first
+      else
+        results
+      end
+    end
+
+    def limit(number)
+      @limit = number
+      self
+    end
+
+    def offset(number)
+      @offset = number
+      self
+    end
+
+    def where(conditions)
+      @conditions = (@conditions || {}).merge(conditions)
+      self
+    end
+
+    def find_by(conditions)
+      where(conditions).first
+    end
+
+    def orders(new_orders)
+      @orders = new_orders
+      self
+    end
+
+    def select(*fields)
+      @fields = fields.flatten
+      self
+    end
+
+    def pluck(*fields)
+      fields.flatten!
+      result = select(fields).map{ |e| fields.map{ |field| e.public_send(field) } }
+      fields.size == 1 ? result.flatten : result
+    end
+
+    private
+
+    def format_page_from_limit_and_offset(limit, offset)
+      min = (offset + 1).to_f
+      max = (offset + limit).to_f
+      limit.upto(limit + offset) do |size|
+        next unless (min / size).ceil == (max / size).ceil
+
+        page = (min / size).ceil
+        start_trim = min - (page - 1) * size - 1
+        end_trim = page * size - max
+        return {
+          page_size: [size, 1000].min,
+          page: page,
+          start_trim: start_trim.to_i,
+          end_trim: end_trim.to_i,
+        }
+      end
+    end
+
+    def shotgun_client
+      Client.shotgun.entities(@type)
+    end
+  end
+end

data/lib/active_shotgun/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveShotgun
-  VERSION = "0.0.2.1"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_shotgun
 version: !ruby/object:Gem::Version
-  version: 0.0.2.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Denis <Zaratan> Pasin
@@ -271,6 +271,7 @@ files:
 - lib/active_shotgun/model/read.rb
 - lib/active_shotgun/model/validations.rb
 - lib/active_shotgun/model/write.rb
+- lib/active_shotgun/query.rb
 - lib/active_shotgun/version.rb
 homepage: https://github.com/zaratan/active_shotgun
 licenses: