s3_index 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09f47a01e5c9ac5c44b32f5e006f787d0ee82cc0
-  data.tar.gz: d9560340c7ee47c509baed7c1090a70a804b6a57
+  metadata.gz: 4ebc8919d29a2d7a697050a9c17a1255899ce551
+  data.tar.gz: 852120e458e1bfd9a651df91a70ce27c032e400d
 SHA512:
-  metadata.gz: 4d6a66d686c99bf983d99e48bbd79640b2e77da61d73f5a6aaf65ce5158f4533a53c31f3fd88a3845558750114bb039309ac026079a171b068456a0d3861dd33
-  data.tar.gz: 04903a0efada0f696aae4b76b68f6ede82de5726af56e779df37265f67f081c962c5b8d8760cc5c8dac62d60e2291e17b239e4adec2fd42e2d3a309f13806020
+  metadata.gz: 5605f6707ce1c1a962df8ce94ead265036de6b2317dbf5905e7c49c0159cbe63977fabe3138f6d10e33558802be1d2dc2955dac0e5ee7a53aafb98fca273f124
+  data.tar.gz: a3ce408ccea48e347970e5ddccc495eb47cfe273a63ac4b0362dfda5fba2b1499bc97d96c99ad1d18cad71f452244dd128008bb5eabdfbaae7a103fcaa2f7ad2

data/lib/s3_index.rb

@@ -6,6 +6,7 @@ module S3Index
   extend ActiveSupport::Autoload
 
   autoload :Index
+  autoload :Accessor
 
   module_function
 
@@ -98,6 +99,12 @@ module S3Index
   def default_client=(client)
     @s3_client = client
   end
+
+  # Let the model handle everything else
+  def method_missing(meth, *args, &block)
+    super unless Index.respond_to?(meth)
+    Index.public_send(meth, *args, &block)
+  end
 end
 
 S3Index.eager_load!

data/lib/s3_index/accessor.rb

@@ -0,0 +1,120 @@
+# module
+module S3Index
+  # Adds S3 backed data accessors to any ActiveRecord model
+  #
+  # ## Example:
+  # ```
+  # class Foo < ActiveRecord::Base
+  #   include S3Index::Accessor
+  #
+  #   s3_index_accessor :s3_data,
+  #     cache_dir: '/tmp'
+  #     bucket: 'foo',
+  #     s3_resource: Aws::S3::Resource.new
+  # end
+  # ```
+  module Accessor
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_s3_index_config
+    end
+
+    class_methods do
+      def s3_index_accessor(name, cache_dir:, bucket: nil, s3_resource: nil)
+        # IMPORTANT never move this line unless you want everything to break.
+        # This ensures lowest descendent has its own hash instance.
+        self._s3_index_config ||= {}
+
+        # do the assignment
+        self._s3_index_config[name] = {
+          name:        name,
+          cache_dir:   cache_dir,
+          bucket:      bucket || name.to_s,
+          s3_resource: s3_resource || Aws::S3::Resource.new
+        }
+
+        class_eval <<-RUBY, __FILE__, __LINE__
+          after_save do |row|
+            handle_s3_index_after_save(:#{name}, _s3_index_config[:#{name}], row)
+          end
+        RUBY
+
+        class_eval(<<-RUBY.strip_heredoc, __FILE__, __LINE__)
+          def #{name}=(value)
+            handle_s3_index_write(:#{name}, _s3_index_config[:#{name}], value)
+          end
+        RUBY
+
+        class_eval(<<-RUBY.strip_heredoc, __FILE__, __LINE__)
+          def #{name}(force: false)
+            handle_s3_index_read(:#{name}, _s3_index_config[:#{name}], force: force)
+          end
+        RUBY
+
+        class_eval(<<-RUBY.strip_heredoc, __FILE__, __LINE__)
+          def #{name}!
+            #{name}(force: true)
+          end
+        RUBY
+
+        class_eval(<<-RUBY.strip_heredoc, __FILE__, __LINE__)
+          def #{name}_index
+            handle_s3_index_record(:#{name}, _s3_index_config[:#{name}])
+          end
+        RUBY
+      end
+    end
+
+    private
+
+    def handle_s3_index_write(name, config, value)
+      File.open(full_cache_path(config), 'wb') { |f| f << value } if self.id
+      instance_variable_set("@_#{name}", value)
+    end
+
+    def handle_s3_index_read(name, config, force:)
+      if force
+        var_name = "@_#{name}".to_sym
+        instance_variable_set(var_name, nil)
+      end
+      instance_var_set_if_needed(name) do
+        unless File.file?(full_cache_path(config))
+          index = handle_s3_index_record(name, config)
+          index.download!(s3: config[:s3_resource])
+        end
+        File.read(full_cache_path(config))
+      end
+    end
+
+    def handle_s3_index_record(name, config)
+      instance_var_set_if_needed("#{name}_index") do
+        Index.find_by(origin_url: full_cache_path(config), s3_bucket: config[:bucket])
+      end
+    end
+
+    def handle_s3_index_after_save(name, config, row)
+      value = instance_variable_get("@_#{name}")
+      handle_s3_index_write(name, config, value)
+      S3Index.upload!(
+        s3: config[:s3_resource],
+        bucket: config[:bucket],
+        src: full_cache_path(config)
+      )
+    end
+
+    def full_cache_path(config)
+      File.join(config[:cache_dir], "#{config[:name]}-#{self.id}")
+    end
+
+    def instance_var_set_if_needed(name, &block)
+      var_name = "@_#{name}".to_sym
+      result = instance_variable_get(var_name)
+      unless result
+        result = block.call
+        instance_variable_set(var_name, result)
+      end
+      result
+    end
+  end
+end

data/lib/s3_index/version.rb

@@ -1,3 +1,3 @@
 module S3Index
-  VERSION = "0.1.1"
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: s3_index
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Scott Pierce
@@ -157,6 +157,7 @@ files:
 - db/schema.rb
 - lib/environment.rb
 - lib/s3_index.rb
+- lib/s3_index/accessor.rb
 - lib/s3_index/index.rb
 - lib/s3_index/version.rb
 - lib/tasks/db.rake