fs_layer 0.0.2

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tags
+*.sw[op]
+.idea/

data/.rspec

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@cabinet --create

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fs_layer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Aldric Giacomoni
+
+MIT License
+
+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,49 @@
+# FSLayer
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fs_layer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fs_layer
+
+## Usage
+
+    FSLayer.retrieve file
+    FSLayer.insert file
+    FSLayer.delete file
+    FSLayer.config do |c|
+      c.fake = true
+      c.log = true
+      c.logger = Logger.new
+    end
+    FSLayer.link('file').to('symlink_destination')
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+### possible vocabulary
+
+* file / folder
+* hanging file
+* shredder
+* recycle bin
+* marker
+* reference
+* index
+* label
+* lock

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => [:spec]

data/fs_layer.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fs_layer/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "fs_layer"
+  gem.version       = FSLayer::VERSION
+  gem.authors       = ["Aldric Giacomoni"]
+  gem.email         = ["trevoke@gmail.com"]
+  gem.description   = %q{Friendly file/directory interface. Secretary not included.}
+  gem.summary       = %q{An interface for files and directories, because using and mocking File/FileUtils is just wrong.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec', '>= 2.12.0'
+  gem.add_development_dependency 'cucumber'
+end

data/lib/fs_layer.rb

@@ -0,0 +1,9 @@
+require_relative 'fs_layer/version'
+require_relative 'fs_layer/index'
+require_relative 'fs_layer/file'
+require_relative 'fs_layer/link'
+require_relative 'fs_layer/api'
+
+module FSLayer
+
+end

data/lib/fs_layer/api.rb

@@ -0,0 +1,29 @@
+module FSLayer
+  class << self
+
+    def fake_it
+      @fake = true
+    end
+
+    def keep_it_real
+      @fake = false
+    end
+
+    def fake?
+      @fake
+    end
+
+    def insert file
+      FSLayer::File.add file
+    end
+
+    def has? file_object
+      Index.known_files.include? file_object 
+    end
+
+    def link file
+      FSLayer::Link.new(FSLayer::File.add(file))
+    end
+  end
+end
+

data/lib/fs_layer/file.rb

@@ -0,0 +1,39 @@
+require 'fileutils'
+
+module FSLayer
+  class File
+    def self.add file
+      FileUtils.touch file unless FSLayer.fake?
+      Index.organize file
+      new file
+    end
+
+    def self.retrieve filename
+      new filename
+    end
+
+    def initialize file
+      @file = file
+    end
+
+    def name
+      ::File.basename @file
+    end
+
+    def exist?
+      ::File.exists? @file
+    end
+
+    def symlink?
+      ::File.symlink? @file
+    end
+
+    def destination
+      Pathname.new(@file).realpath.to_s
+    end
+
+    def path
+      @file
+    end
+  end
+end

data/lib/fs_layer/index.rb

@@ -0,0 +1,11 @@
+module FSLayer
+  class Index
+    def self.known_files
+      @known_files ||= []
+    end
+
+    def self.organize file
+      known_files << file
+    end
+  end
+end

data/lib/fs_layer/link.rb

@@ -0,0 +1,14 @@
+module FSLayer
+  class Link
+    attr_reader :file
+    
+    def initialize file
+      @file = file
+    end
+
+    def to symlink_destination
+      ::File.symlink(file.path, symlink_destination) unless FSLayer.fake?
+      FSLayer::File.add(symlink_destination)
+    end
+  end
+end

data/lib/fs_layer/version.rb

@@ -0,0 +1,3 @@
+module FSLayer
+  VERSION = "0.0.2"
+end

data/spec/cabinet_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require File.expand_path File.join(File.dirname(__FILE__), '..', 'lib', 'fs_layer')
+
+describe FSLayer do
+  subject { FSLayer }
+
+  describe "Faking it" do
+
+    before do
+      subject.fake_it
+    end
+
+    after do
+      subject.keep_it_real
+    end
+
+    it "does not really create files" do
+      file = subject.insert '/tmp/file'
+      file.should be_an_instance_of FSLayer::File
+      subject.has?('/tmp/file').should be_true
+      file.should_not exist
+    end
+
+    it "does not really create symlinks" do
+      subject.insert '/tmp/file1'
+      file = subject.link('/tmp/file1').to('/tmp/file2')
+      file.should be_an_instance_of FSLayer::File
+      file.path.should eq '/tmp/file2'
+      ::File.exist?(file.path).should be_false
+    end
+  end
+end

data/spec/file_spec.rb

@@ -0,0 +1,37 @@
+require_relative "../lib/fs_layer.rb"
+require 'spec_helper'
+
+module FSLayer
+  describe File do
+    let(:file) { "filename" }
+
+    context "that exists" do
+      before { File.add file }
+      after { FileUtils.rm_f file }
+
+      context "has relevant information" do
+        subject { File.retrieve file }
+        its(:name) { should eq file }
+        its(:exist?) { should be_true }
+        its(:symlink?) { should be_false }
+      end
+
+    end
+
+    context "that does not exist" do
+      before do
+        FSLayer.fake_it
+        File.add file 
+      end
+      after do
+        FSLayer.keep_it_real
+      end
+
+      context "has relevant information" do
+        subject { File.retrieve file }
+        its(:name) { should eq file}
+        its(:exist?) { should be_false }
+      end
+    end
+  end
+end

data/spec/index_spec.rb

@@ -0,0 +1,13 @@
+require_relative '../lib/fs_layer.rb'
+require 'spec_helper'
+
+module FSLayer
+  describe Index do
+    let(:file) { 'some_file_name' }
+    after { FileUtils.rm_f file }
+    it "adds them to the list of managed files" do
+      File.add file
+      Index.known_files.should include(file)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: fs_layer
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Aldric Giacomoni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Friendly file/directory interface. Secretary not included.
+email:
+- trevoke@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fs_layer.gemspec
+- lib/fs_layer.rb
+- lib/fs_layer/api.rb
+- lib/fs_layer/file.rb
+- lib/fs_layer/index.rb
+- lib/fs_layer/link.rb
+- lib/fs_layer/version.rb
+- spec/cabinet_spec.rb
+- spec/file_spec.rb
+- spec/index_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1559428345412472295
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1559428345412472295
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: An interface for files and directories, because using and mocking File/FileUtils
+  is just wrong.
+test_files:
+- spec/cabinet_spec.rb
+- spec/file_spec.rb
+- spec/index_spec.rb
+- spec/spec_helper.rb