dir_model 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e2aa05d706d3f1d0062abcabac6716361245c35
-  data.tar.gz: 35ef12280756a22d8c6be20be30fe5530478a73b
+  metadata.gz: 446e930d0a4af01c2fd5a48cbfb3e742e0a35b32
+  data.tar.gz: 8abc4fe852ccdfb4a259babd81e3ee080f33e8ab
 SHA512:
-  metadata.gz: 6e1ed34d9a1a8f5a5b1fe6a28adc19ab7ecbc0679972cada464e4b80828a4306c41505387ad0e09b85822168d8f4bac4fcd997c486b33b125c402551e3057a73
-  data.tar.gz: 8765c79b182f2c5b6d38a676b4bb1bf678f30e85b5b1dd3a5073ac17c69b13e5ceb18916d3f7c1745db9798516515a819cfa90256353c54954be56d2fc44b78b
+  metadata.gz: 58278e1b4641a695da21cc21f91c696517d85807ff0824175cfe32884e097863b5658871571498092c2b2b46a3990c9f65d7d27be6b5ee5a7ad7cc948a89206d
+  data.tar.gz: 409e249c4c01de393961daef38df9c464ee8c79870efa7fc4633a65fba65743d0d57248b6bf59a709c17d6f82f7e698c50912e10e52825ba8196707542c47892

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+### VERSION 0.2.0
+
+* Apply [CsvRowModel](https://github.com/FinalCAD/csv_row_model) pattern for export.
+
+### VERSION 0.1.0
+
+* First extraction

data/Gemfile

@@ -3,6 +3,8 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in dir_model.gemspec
 gemspec
 
+# gem 'inherited_class_var', path: '../inherited_class_var'
+
 gem "bundler", "> 1.3"
 gem "rake", "~> 10.0"
 
@@ -10,4 +12,4 @@ group :test do
   gem "rspec"
   gem "codeclimate-test-reporter"
   gem 'pry-byebug'
-end
+end

data/README.md

@@ -21,28 +21,50 @@ Or install it yourself as:
 ## Usage
 
 ### Export
+
 ```ruby
-class ImageDir < DirModel::Export
-  file :zone_image
+class ImageDir
+  include DirModel
+
+  file :image, path: -> { "#{dir}/#{sub_dir}" }, name: -> { "#{image_name}.png" }
+end
 
-  def zone_image_source
-    File.new("spec/fixtures/image.png")
+class ImageExportDir < ImageDir
+  include DirModel::Export
+
+  def dir
+    'Sectors'
   end
-  def zone_image_name
-    "testing.png"
+
+  def sub_dir
+    source_model.sector_name
   end
 
-  def _generate
-    mk_chdir "level1" do
-      mk_chdir "level2" do
-        copy_file :zone_image
-      end
-    end
+  def image_name
+    source_model.zone_name
   end
+
+  def image
+    source_model.zone
+  end
+end
+
+fixture_models = [
+  OpenStruct.new({
+    id: 42,
+    sector_name: 'sector_name',
+    zone_name: 'zone_name',
+    zone: File.new('spec/fixtures/image.png'),
+  })
+]
+
+exporter = DirModel::Export::AggregateDir.new(ImageExportDir)
+
+exporter.generate do |dir|
+  models.each { |model| dir << model }
 end
 
-image_dir = ImageDir.new
-image_dir.path # => path representing the above: "#{image_dir.path}/level1/level2/testing.png"
+exporter.dir_path # => path of generated dir .../Sectors
 ```
 
 ## zip_dir
@@ -55,56 +77,4 @@ zip_file = zipper.generate do |z|
 end
 ```
 
-**Ensure that `require zip_dir` occurs before `dir_model`**
-
-## Future
-Define a schema for the directory.
-```ruby
-class ImageDir
-  include DirModel
-  
-  file :zone_image, path: "{{root}}/{{branch}}", name: "{{zone_name}}" 
-end
-```
-
-To export, define your export model like [`ActiveModel::Serializer`](https://github.com/rails-api/active_model_serializers)
-and generate the directory requirements:
-
-```ruby
-class ImageExportDir < ImageDir
-  include DirModel::Export
-  
-  # below are method overrides with default implementation
-  #
-  # overriding is recommended
-  #
-  def root; source_model.root end
-  def branch; source_model.branch end
-  def zone_name; source_model.zone_name end
-  
-  # define your image source
-  #
-  # override with something like: File.new("path/to/image.png")
-  #
-  def zone_image
-    source_model.zone_image
-  end
-end
-```
-
-To import, define your import model, which works like [`ActiveRecord`](http://guides.rubyonrails.org/active_record_querying.html)
-wrapping over a directory:
-
-```ruby
-class ImageImportDir < ImageDir
-  include DirModel::Import
-  
-  #
-  # below are method overrides with default implementation
-  #
-  def root; "level1" end
-  def branch; "level2" end
-  def zone_name; "testing" end
-  def zone_image; File.new("....") end
-end
-```
+**Ensure that `require zip_dir` occurs before `dir_model` (for now)**

data/UPGRADE.md

@@ -0,0 +1,26 @@
+# Upgrading
+
+# Upgrading from 0.1.0 to 0.2.0
+
+You have to change
+
+```
+def _generate
+  mk_chdir "level1" do
+    mk_chdir "level2" do
+      copy_file :zone_image
+    end
+  end
+end
+```
+
+for a DirModel
+
+```
+class ImageDir
+  include DirModel
+
+  file :image, path: -> { "#{dir}/#{sub_dir}" }, name: -> { "#{image_name}.png" }
+end
+```
+see the README

data/dir_model.gemspec

@@ -17,4 +17,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport',       '~> 4.2'
+  spec.add_dependency 'inherited_class_var', '~> 0.1'
 end

data/lib/dir_model/core_ext/dir.rb

@@ -2,9 +2,9 @@ class Dir
   class << self
     def clean_entries(dir)
       entries = entries(dir)
-      entries.delete "."
-      entries.delete ".."
+      entries.delete '.'
+      entries.delete '..'
       entries
     end
   end
-end
+end

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

@@ -7,4 +7,4 @@ if defined?(ZipDir)
       dir.cleanup
     end
   end
-end
+end

data/lib/dir_model/export/aggregate_dir.rb

@@ -0,0 +1,33 @@
+require 'active_support/hash_with_indifferent_access'
+
+module DirModel
+  module Export
+    class AggregateDir
+      include Utils
+
+      attr_reader :export_dir_model_class, :context, :dir_path
+
+      # @param [Export] export_model export model class
+      def initialize(export_dir_model_class, context={})
+        @export_dir_model_class = export_dir_model_class
+        @context                = context.to_h.symbolize_keys
+        @dir_path               = Dir.mktmpdir
+      end
+
+      # Add a row_model to the
+      # @param [] source_model the source model of the export file model
+      # @param [Hash] context the extra context given to the instance of the file model
+      def append_model(source_model, context={})
+        source_path = export_dir_model_class.new(source_model, context.reverse_merge(self.context)).path
+        FileUtils.cp_r Dir.glob("#{source_path}/*"), dir_path
+      end
+      alias_method :<<, :append_model
+
+      def generate
+        yield self
+        self
+      end
+
+    end
+  end
+end

data/lib/dir_model/export.rb

@@ -1,82 +1,45 @@
 module DirModel
-  class Export
-    def path
-      generate unless generated?
-      @temp_path
-    end
+  module Export
 
-    def entry_paths
-      Dir.clean_entries(path).map {|entry| File.join path, entry }
-    end
+    attr_reader :source_model, :context
 
-    def valid?
-      !file_sources.any? { |file_source| file_source.nil? || file_source.read.nil? }
-    rescue
-      false
+    # @param [Model] source_model object to export to files
+    # @param [Hash]  context
+    def initialize(source_model, context={})
+      @source_model = source_model
+      @context      = OpenStruct.new(context)
+      @root_path    = Dir.mktmpdir
     end
 
-    def file_sources
-      self.class.files.map { |file| file_source(file) }
-    end
-    def file_source(file)
-      public_send(self.class.file_source_method_name(file))
-    end
-    def file_name(file)
-      File.join(*pwd, public_send(self.class.file_name_method_name(file)))
+    def path
+      generate unless generated?
+      @root_path
     end
 
+    private
+
     def generated?
       !!@generated
     end
+
     def generate
       cleanup if generated?
-      @temp_path = Dir.mktmpdir
 
-      @pwd = [@temp_path]
-      _generate
+      self.class.files.each do |file_name, options|
+        dir_path  = instance_exec(&options[:path])
+        file_path = File.join(dir_path, instance_exec(&options[:name]))
+
+        mkdir { File.join(@root_path, dir_path) }
+
+        File.open(File.join(@root_path, file_path), 'wb') {|f| f.write(self.public_send(file_name).read) }
+      end
     ensure
       @generated = true
     end
 
     def cleanup
-      FileUtils.remove_entry_secure @temp_path
+      FileUtils.remove_entry @root_path
       @generated = false
     end
-
-    protected
-    attr_reader :pwd
-
-    def copy_file(file)
-      File.open(file_name(file), 'wb') {|f| f.write(file_source(file).read) }
-    end
-
-    def _generate
-      raise NotImplementedError.new("Missing #{self.class} implementation")
-    end
-
-    def mk_chdir(dir, *permissions_int)
-      @pwd << dir
-      Dir.mkdir(File.join(*pwd), *permissions_int)
-      yield
-    ensure
-      @pwd.pop
-    end
-
-    class << self
-      attr_reader :files
-
-      def file(*files)
-        @files ||= []
-        @files += files
-      end
-
-      def file_name_method_name(file)
-        "#{file}_name"
-      end
-
-      def file_source_method_name(file)
-        "#{file}_source"
-      end
-    end
   end
-end
+end

data/lib/dir_model/utils.rb

@@ -0,0 +1,7 @@
+module Utils
+  extend ActiveSupport::Concern
+
+  def mkdir
+    FileUtils.mkdir_p(yield)
+  end
+end

data/lib/dir_model/version.rb

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

data/lib/dir_model.rb

@@ -1,10 +1,37 @@
-require "dir_model/version"
+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/export'
+require 'dir_model/export/aggregate_dir'
+
+require 'inherited_class_var'
 
 module DirModel
-  # Your code goes here...
+  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,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: dir_model
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Steve Chung
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-27 00:00:00.000000000 Z
-dependencies: []
+date: 2015-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: inherited_class_var
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 description: 
 email:
 - hello@stevenchung.ca
@@ -20,10 +48,12 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- UPGRADE.md
 - bin/console
 - bin/setup
 - dir_model.gemspec
@@ -31,6 +61,8 @@ files:
 - 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/utils.rb
 - lib/dir_model/version.rb
 homepage: https://github.com/FinalCAD/dir_model
 licenses: