dir_model 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 446e930d0a4af01c2fd5a48cbfb3e742e0a35b32
-  data.tar.gz: 8abc4fe852ccdfb4a259babd81e3ee080f33e8ab
+  metadata.gz: b37d3d709550ebba94791438eb647ff38631caaa
+  data.tar.gz: 6897081d0e48e834a5e641b33097ec5b6bfd8e23
 SHA512:
-  metadata.gz: 58278e1b4641a695da21cc21f91c696517d85807ff0824175cfe32884e097863b5658871571498092c2b2b46a3990c9f65d7d27be6b5ee5a7ad7cc948a89206d
-  data.tar.gz: 409e249c4c01de393961daef38df9c464ee8c79870efa7fc4633a65fba65743d0d57248b6bf59a709c17d6f82f7e698c50912e10e52825ba8196707542c47892
+  metadata.gz: 6e4ea16033776a1d2d3b6a6e331b8ee4660b56365a2c4b5014e700aad49b5157b7ff7579f056de55eaf7b077bffb332d402e5ead8f5870a15a8bd2d9390d7020
+  data.tar.gz: fa6270d818cca60016271b3a3bd31ba40982227cc817dcd320f530c892c6876c267a4d3d59c5196ecd2361aac9e81acc74c1323ff6265e2c6e8b2f260c8172ba

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### VERSION 0.3.0
+
+* Add Import feature
+
 ### VERSION 0.2.0
 
 * Apply [CsvRowModel](https://github.com/FinalCAD/csv_row_model) pattern for export.

data/README.md

@@ -20,15 +20,59 @@ Or install it yourself as:
 
 ## Usage
 
+### Import
+
+```ruby
+class ImageDir
+  include DirModel::Model
+
+  file :image, regex: -> { /Zones\/Sector_(?<sector_id>.*)\/Zone_(?<zone_id>.*)\.(?<extension>png|jpg)/i }
+end
+```
+
+named matches are available under `matches[:sector_id]` or directly when you calling `sector_id`
+
+An implementation possible of Import
+
+```ruby
+class ImageImportDir < ImageDir
+  include DirModel::Import
+
+  def assign!
+    model.send(method, image)
+  end
+
+  protected
+
+  def model
+    Project.find(context[:project_id]).sectors.find(sector_id).zones.find(zone_id)
+  end
+
+  def method
+    :blueprint
+  end
+end
+```
+
+You can have access at the file through
+
+`ImageImportDir.new(source_path, project_id: 42).image`
+
 ### Export
 
 ```ruby
 class ImageDir
-  include DirModel
+  include DirModel::Model
 
-  file :image, path: -> { "#{dir}/#{sub_dir}" }, name: -> { "#{image_name}.png" }
+  file :image, path: -> { "#{dir}/#{sub_dir}" }, name: -> { image_name }
 end
+```
 
+`path` and `name` can take Proc or String if doesn't have any interpolation.
+
+If you don't know the extension of your image it will be automatically discover, but this works only for image so if you send, for instance, a json file you have to explicitly provide extension on the `:name` options
+
+```ruby
 class ImageExportDir < ImageDir
   include DirModel::Export
 

data/UPGRADE.md

@@ -1,5 +1,10 @@
 # Upgrading
 
+* Model is now a module you have to change include from `include DirModel` to `include DirModel::Model`
+
+# Upgrading from 0.2.0 to 0.3.0
+
+
 # Upgrading from 0.1.0 to 0.2.0
 
 You have to change

data/dir_model.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activesupport',       '~> 4.2'
   spec.add_dependency 'inherited_class_var', '~> 0.1'
+  spec.add_dependency 'fastimage',           '~> 1.8'
 end

data/lib/dir_model/export.rb

@@ -1,3 +1,5 @@
+require 'fastimage'
+
 module DirModel
   module Export
 
@@ -25,18 +27,39 @@ module DirModel
     def generate
       cleanup if generated?
 
-      self.class.files.each do |file_name, options|
-        dir_path  = instance_exec(&options[:path])
-        file_path = File.join(dir_path, instance_exec(&options[:name]))
+      self.class.file_names.each do |file_name|
+        options = self.class.options(file_name)
+
+        dir_path  = get_value_of(options[:path])
+        file_path = File.join(dir_path, get_value_of(options[:name]))
 
         mkdir { File.join(@root_path, dir_path) }
 
+       file_path = ensure_extension(file_path, file_name)
+
         File.open(File.join(@root_path, file_path), 'wb') {|f| f.write(self.public_send(file_name).read) }
       end
     ensure
       @generated = true
     end
 
+    def ensure_extension(file_path, file_method_name)
+      file_path_with_extension = file_path
+      if File.extname(file_path).blank?
+        if ext = FastImage.type(self.public_send(file_method_name))
+          file_path_with_extension = file_path + '.' + ext.to_s
+        else
+          raise StandardError.new("options :name should provid an extension")
+        end
+      end
+      file_path_with_extension
+    end
+
+    def get_value_of(string_or_proc)
+      return string_or_proc if string_or_proc.is_a?(String)
+      instance_exec(&string_or_proc)
+    end
+
     def cleanup
       FileUtils.remove_entry @root_path
       @generated = false

data/lib/dir_model/import/dir.rb

@@ -0,0 +1,57 @@
+require 'forwardable'
+
+module DirModel
+  module Import
+    class Dir # File
+      extend Forwardable
+
+      attr_reader :index
+      attr_reader :path
+      attr_reader :import_dir_model_class
+      attr_reader :context
+      attr_reader :current_dir_model
+      attr_reader :previous_dir_model
+
+      def_delegators :@path, :end?
+
+      def initialize(source_path, import_dir_model_class, context={})
+        @path, @import_dir_model_class, @context = Path.new(source_path), import_dir_model_class, context.to_h.symbolize_keys
+        reset
+      end
+
+      def reset
+        path.reset!
+        @index = -1
+        @current_dir_model = nil
+      end
+
+      def each(context={})
+        return to_enum(__callee__) unless block_given?
+
+        while self.next(context)
+          next if skip?
+          yield current_dir_model
+        end
+      end
+
+      def next(context={})
+        return if end?
+
+        context = context.to_h.reverse_merge(self.context)
+        @previous_dir_model = current_dir_model
+        @current_dir_model = import_dir_model_class.next(path, context, previous_dir_model)
+        @index += 1
+        @current_dir_model = @index = nil if end?
+
+        current_dir_model
+      end
+
+      private
+
+      def skip?
+        !!current_dir_model.try(:skip?)
+      end
+
+    end
+  end
+end

data/lib/dir_model/import/path.rb

@@ -0,0 +1,80 @@
+module DirModel
+  module Import
+    class Path # Csv
+
+      attr_reader :path
+      attr_reader :index
+      attr_reader :current_path
+      attr_reader :previous_path
+
+      def initialize(path)
+        @path = path
+        reset!
+      end
+
+      def size
+        @size ||= ruby_path.size
+      end
+
+      def reset!
+        @index = -1
+        @current_path = @ruby_path = @previous_path = nil
+      end
+
+      def start?
+        index == -1
+      end
+
+      def end?
+        index.nil?
+      end
+
+      def next_path
+        @next_path ||= _read_path
+      end
+
+      def read_path
+        @previous_path = @current_path
+        unless caching_value?
+          @current_path = _read_path { forward! }
+        end
+        current_path
+      end
+
+      protected
+
+      def caching_value?
+        if @next_path
+          @current_path = @next_path
+          @next_path = nil
+          forward!
+          true
+        else
+          false
+        end
+      end
+
+      def ruby_path
+        @ruby_path ||= Pathname.glob("#{path}/**/*").each
+      end
+
+      def _read_path
+        path = ruby_path.next.to_path
+        yield if block_given?
+        path
+      rescue StopIteration
+        set_end
+       nil
+      end
+
+      def forward!
+        @index += 1
+      end
+
+      def set_end
+        @current_path = @index = nil
+      end
+
+    end
+  end
+end

data/lib/dir_model/import.rb

@@ -0,0 +1,73 @@
+module DirModel
+  module Import
+    extend ActiveSupport::Concern
+
+    attr_reader :context, :source_path, :index, :previous
+
+    def initialize(path, options={})
+      @source_path, @context = path, OpenStruct.new(options[:context])
+      @index, @previous = options[:index], options[:previous].try(:dup)
+      @load_state = :ghost
+      @file_infos = {}
+    end
+
+    def matches
+      load
+      file_infos[:options][:match]
+    end
+
+    def image
+      File.open(source_path)
+    end
+
+    def skip?
+      load
+      !@_match
+    end
+
+    def method_missing(name, *args, &block)
+      load
+      matches[name]
+    rescue IndexError
+      super
+    end
+
+    module ClassMethods
+      def next(path, context={}, previous=nil)
+        path.read_path
+        new(path.current_path, index: path.index, context: context, previous: previous)
+      end
+    end
+
+    private
+
+    attr_reader :load_state, :file_infos
+
+    def match?
+      return if load_state == :loaded
+
+      @_match ||= begin
+        loader do
+          self.class.file_names.each do |file_name|
+            options = self.class.options(file_name)
+
+            if match = (source_path||'').match(options[:regex].call)
+              @file_infos = { file: file_name, options: options.merge(match: match) }
+              return true
+            end
+          end
+          false
+        end
+      end
+    end
+    alias_method :load, :match?
+
+    def loader
+      @load_state = :loading
+      result = yield
+      @load_state = :loaded
+      result
+    end
+
+  end
+end

data/lib/dir_model/model/files.rb

@@ -0,0 +1,38 @@
+module DirModel
+  module Model
+    module Files
+      extend ActiveSupport::Concern
+
+      included do
+        include InheritedClassVar
+        inherited_class_hash :files
+      end
+
+      module ClassMethods
+        # @return [Array<Symbol>] file names for the row model
+        def file_names
+          files.keys
+        end
+
+        # @param [Symbol] file_name name of file to find option
+        # @return [Hash] options for the file_name
+        def options(file_name)
+          files[file_name]
+        end
+
+        # @param [Symbol] file_name name of file to find index
+        # @return [Integer] index of the file_name
+        def index(file_name)
+          file_names.index file_name
+        end
+
+        protected
+
+        def file(file_name, options={})
+          merge_files(file_name.to_sym => options)
+        end
+
+      end
+    end
+  end
+end

data/lib/dir_model/model.rb

@@ -0,0 +1,10 @@
+module DirModel
+  module Model
+    extend ActiveSupport::Concern
+
+    included do
+      include Utils
+      include Files
+    end
+  end
+end

data/lib/dir_model/version.rb

@@ -1,3 +1,3 @@
 module DirModel
-  VERSION = "0.2.0"
+  VERSION = '0.3.0'
 end

data/lib/dir_model.rb

@@ -1,37 +1,20 @@
+require 'inherited_class_var'
+
 require 'dir_model/version'
 
 require 'active_support/concern'
 
 require 'dir_model/utils'
 
-require 'dir_model/core_ext/dir'
-require 'dir_model/core_ext/zip_dir/zipper'
+require 'dir_model/model'
+require 'dir_model/model/files'
 
 require 'dir_model/export'
 require 'dir_model/export/aggregate_dir'
 
-require 'inherited_class_var'
+require 'dir_model/import'
+require 'dir_model/import/dir'
+require 'dir_model/import/path'
 
 module DirModel
-  extend ActiveSupport::Concern
-
-  included do
-    include Utils
-    include InheritedClassVar
-    inherited_class_hash :files
-  end
-
-  module ClassMethods
-
-    # @return [Array<Symbol>] file names
-    def file_names
-      files.keys
-    end
-
-    protected
-
-    def file(file_name, options={})
-      merge_files(file_name.to_sym => options)
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dir_model
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Steve Chung
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-19 00:00:00.000000000 Z
+date: 2015-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: fastimage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 description: 
 email:
 - hello@stevenchung.ca
@@ -58,10 +72,13 @@ files:
 - bin/setup
 - dir_model.gemspec
 - lib/dir_model.rb
-- lib/dir_model/core_ext/dir.rb
-- lib/dir_model/core_ext/zip_dir/zipper.rb
 - lib/dir_model/export.rb
 - lib/dir_model/export/aggregate_dir.rb
+- lib/dir_model/import.rb
+- lib/dir_model/import/dir.rb
+- lib/dir_model/import/path.rb
+- lib/dir_model/model.rb
+- lib/dir_model/model/files.rb
 - lib/dir_model/utils.rb
 - lib/dir_model/version.rb
 homepage: https://github.com/FinalCAD/dir_model

data/lib/dir_model/core_ext/dir.rb

@@ -1,10 +0,0 @@
-class Dir
-  class << self
-    def clean_entries(dir)
-      entries = entries(dir)
-      entries.delete '.'
-      entries.delete '..'
-      entries
-    end
-  end
-end

data/lib/dir_model/core_ext/zip_dir/zipper.rb

@@ -1,10 +0,0 @@
-if defined?(ZipDir)
-  class ZipDir::Zipper
-    def add_and_cleanup_dir(dir)
-      return unless dir.valid?
-
-      dir.entry_paths.each { |path| add_path path }
-      dir.cleanup
-    end
-  end
-end