dir_model 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e2aa05d706d3f1d0062abcabac6716361245c35
+  data.tar.gz: 35ef12280756a22d8c6be20be30fe5530478a73b
+SHA512:
+  metadata.gz: 6e1ed34d9a1a8f5a5b1fe6a28adc19ab7ecbc0679972cada464e4b80828a4306c41505387ad0e09b85822168d8f4bac4fcd997c486b33b125c402551e3057a73
+  data.tar.gz: 8765c79b182f2c5b6d38a676b4bb1bf678f30e85b5b1dd3a5073ac17c69b13e5ceb18916d3f7c1745db9798516515a819cfa90256353c54954be56d2fc44b78b

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.idea/*

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dir_model.gemspec
+gemspec
+
+gem "bundler", "> 1.3"
+gem "rake", "~> 10.0"
+
+group :test do
+  gem "rspec"
+  gem "codeclimate-test-reporter"
+  gem 'pry-byebug'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Steve Chung
+
+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

@@ -0,0 +1,110 @@
+# DirModel
+
+Import and export directories with an ORM-like interface.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dir_model'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dir_model
+
+## Usage
+
+### Export
+```ruby
+class ImageDir < DirModel::Export
+  file :zone_image
+
+  def zone_image_source
+    File.new("spec/fixtures/image.png")
+  end
+  def zone_image_name
+    "testing.png"
+  end
+
+  def _generate
+    mk_chdir "level1" do
+      mk_chdir "level2" do
+        copy_file :zone_image
+      end
+    end
+  end
+end
+
+image_dir = ImageDir.new
+image_dir.path # => path representing the above: "#{image_dir.path}/level1/level2/testing.png"
+```
+
+## zip_dir
+Use [`zip_dir`](https://github.com/FinalCAD/zip_dir) to zip DirModel::Export instances:
+```ruby
+# Zip
+zipper = ZipDir::Zipper.new
+zip_file = zipper.generate do |z|
+  z.add_and_cleanup_dir __dir_model_export__
+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
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dir_model"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dir_model.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dir_model/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dir_model"
+  spec.version       = DirModel::VERSION
+  spec.authors       = ["Steve Chung"]
+  spec.email         = ["hello@stevenchung.ca"]
+
+  spec.summary       = "Import and export directories with an ORM-like interface."
+  spec.homepage      = "https://github.com/FinalCAD/dir_model"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/dir_model/core_ext/dir.rb

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,10 @@
+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

data/lib/dir_model/export.rb

@@ -0,0 +1,82 @@
+module DirModel
+  class Export
+    def path
+      generate unless generated?
+      @temp_path
+    end
+
+    def entry_paths
+      Dir.clean_entries(path).map {|entry| File.join path, entry }
+    end
+
+    def valid?
+      !file_sources.any? { |file_source| file_source.nil? || file_source.read.nil? }
+    rescue
+      false
+    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)))
+    end
+
+    def generated?
+      !!@generated
+    end
+    def generate
+      cleanup if generated?
+      @temp_path = Dir.mktmpdir
+
+      @pwd = [@temp_path]
+      _generate
+    ensure
+      @generated = true
+    end
+
+    def cleanup
+      FileUtils.remove_entry_secure @temp_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

data/lib/dir_model/version.rb

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

data/lib/dir_model.rb

@@ -0,0 +1,10 @@
+require "dir_model/version"
+
+require 'dir_model/core_ext/dir'
+require 'dir_model/core_ext/zip_dir/zipper'
+
+require 'dir_model/export'
+
+module DirModel
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: dir_model
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steve Chung
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-27 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- hello@stevenchung.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- 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/version.rb
+homepage: https://github.com/FinalCAD/dir_model
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Import and export directories with an ORM-like interface.
+test_files: []