fi 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f1456ebcfaf4ecfddca6d8c6daae088898eb1e2
-  data.tar.gz: 858eb571c719bbf3824606ff6b8d247f9d16d529
+  metadata.gz: 454a505bd26409dfc6582a01e89534d98967dcab
+  data.tar.gz: be1adf58b2b9f40276a6ed960e67ae7d2e981ed2
 SHA512:
-  metadata.gz: 9db53c445f942e3852736d6423095bd71d58e493003e54a2c0806a2abd9ba2921471cb2021008153ef4eeebbb4dfad4dd515dc3d5435b6d668070d051d871a71
-  data.tar.gz: e256aecb986402e559d49c405d1c15a9a6f9cf39a801986740bda28a56e64db6b75a8abc61976222e8600e127187c2465db58fc7e48e22e451c3a89c3c5dca38
+  metadata.gz: aae9e1719ace11bb274081859923163daa02d1eb94b59ae44be47683cc482fc018f46f968aa47694787c5d6948297a2f5dfb6b919bb8fd3ab7d07d04fbed18e1
+  data.tar.gz: 5097dd4364bb39208b5fbef4effe2cecfabf863367603f6027da087d8167a4e4abbcfc195c3ce7cecf7ec0f13f53e00428350eafdb581135d3adcd46882bde70

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

data/Gemfile

@@ -1,4 +1,8 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in fi.gemspec
 gemspec
+
+gem 'rspec'
+
+gem 'guard-rspec', require: false
+gem 'growl', require: false

data/Guardfile

@@ -0,0 +1,18 @@
+# directories %w(app lib config test spec feature)
+# clearing :on
+notification :growl
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/features/path.feature

@@ -0,0 +1,5 @@
+Feature: Manipulating file paths
+
+  Ruby doesn't provide a consistent API to work with file paths. In order to
+  eliminate this problem we need to develop a library that facilitate reading,
+  creating, and editing files.

data/fi.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Fi::VERSION
   spec.authors       = ["Slava Pavlutin"]
   spec.email         = ["sl.pavlutin@gmail.com"]
-  spec.summary       = %q{Working with files never was easier}
+  spec.summary       = %q{Working with files, easier.}
   spec.description   = %q{Fi - File Interaction}
   spec.homepage      = ""
   spec.license       = "MIT"

data/lib/fi/dir.rb

@@ -0,0 +1,55 @@
+require "fi/path"
+require "fileutils"
+
+module Fi
+  class Dir
+    def self.current
+      ::Dir.pwd
+    end
+
+    def self.change(dir=home)
+      ::Dir.chdir dir
+    end
+
+    def self.list(path=current)
+      directories = list! path
+      directories.reject { |d| d =~ /^\./ }
+    end
+
+    def self.list!(path=current)
+      ::Dir.entries Path.expand(path)
+    end
+
+    def self.exist?(dirname)
+      ::Dir.exist? dirname
+    end
+
+    def self.delete(dir)
+      FileUtils.rm_r dir
+    end
+
+    def self.delete!(dir)
+      FileUtils.rm_rf dir
+    end
+
+    def self.rename(dirname, name)
+      FileUtils.mv dirname, name
+    end
+
+    def self.home(user=nil)
+      return ::Dir.home user if user
+      ::Dir.home
+    end
+
+    def initialize(*names)
+      names.each do |name|
+        dirs = Path.split name
+        base_dir = Dir.current
+        dirs.each do |dir|
+          base_dir = Path.join base_dir, dir
+          ::Dir.mkdir base_dir
+        end
+      end
+    end
+  end
+end

data/lib/fi/file.rb

@@ -0,0 +1,14 @@
+module Fi
+  class File < ::File
+    def initialize(path, content='')
+      @path = path
+      ::File.open(@path, 'w+') do |f|
+        f.write content
+      end
+    end
+
+    def content
+      Fi.read @path
+    end
+  end
+end

data/lib/fi/path.rb

@@ -0,0 +1,15 @@
+module Fi
+  class Path
+    def self.expand(*path)
+      File.expand_path File.join(*path)
+    end
+
+    def self.join(*paths)
+      File.join *paths
+    end
+
+    def self.split(path)
+      path.split '/'
+    end
+  end
+end

data/lib/fi/version.rb

@@ -1,3 +1,3 @@
 module Fi
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/fi.rb

@@ -1,5 +1,24 @@
+require "fi/path"
+require "fi/dir"
+require "fi/file"
 require "fi/version"
 
 module Fi
-  # Your code goes here...
+  class << self
+    def new(path, content='')
+      Fi::File.new path, content
+    end
+
+    def open(path)
+      ::File.open path
+    end
+
+    def read(path)
+      ::File.read path
+    end
+
+    def delete(path)
+      ::File.delete path
+    end
+  end
 end

data/spec/fi/dir_spec.rb

@@ -0,0 +1,112 @@
+require "fi/dir"
+
+module Fi
+  RSpec.describe Dir do
+    let(:root) { Dir.current }
+    let(:hidden_files) { /^\./ }
+    let(:testdir) { 'testdir' }
+
+    it "can get current directory" do
+      expect(Dir.current).to eq ::Dir.pwd
+    end
+
+    it "can get home directory" do
+      expect(Dir.home).to eq ENV['HOME']
+    end
+
+    it "can determine whether a directory exist" do
+      expect(Dir.exist? '.').to be true
+      expect(Dir.exist? 'nope').to be false
+    end
+
+    it "can rename a directory" do
+      Dir.new 't'
+      Dir.rename 't', 'temp'
+
+      expect('temp').to be_directory
+      expect('t').not_to be_directory
+
+      Dir.delete! 'temp'
+    end
+
+    # specify "change current directory" do
+    #   Dir.change Dir.home
+    #   expect(Dir.current).to eq Dir.home
+    #   Dir.change root
+    # end
+
+    describe ".list and .list!" do
+      it "lists files in current directory by default" do
+        expect(Dir.list).to eq Dir.list Dir.current
+        expect(Dir.list!).to eq Dir.list! Dir.current
+      end
+
+      it "lists non-hidden files in a directory" do
+        list = Dir.list '~/'
+        expect(list).not_to be_empty
+        expect(list).not_to include hidden_files
+      end
+
+      it "lists all files in a directory" do
+        list = Dir.list! '~/'
+        expect(list).not_to be_empty
+        expect(list).to include hidden_files
+      end
+    end
+
+
+    describe ".new" do
+      after { Dir.delete! testdir }
+
+      it "can create a directory" do
+        dir = Dir.new testdir
+        expect(testdir).to be_directory
+      end
+
+      it "can create nested directories" do
+        Dir.new 'new/yet/another'
+
+        expect('new').to be_directory
+        expect('new/yet').to be_directory
+        expect('new/yet/another').to be_directory
+
+        Dir.delete! 'new'
+      end
+
+      it "can create multiply directories" do
+        Dir.new testdir, "#{testdir}1"
+
+        expect(testdir).to be_directory
+        expect("#{testdir}1").to be_directory
+
+        Dir.delete! "#{testdir}1"
+      end
+
+      it "raises an error when directory already exists" do
+        Dir.new testdir
+
+        expect(testdir).to be_directory
+        expect { Dir.new testdir }.to raise_error
+      end
+    end
+
+
+    describe ".delete and .delete!" do
+      specify "`.delete` deletes an empty directory" do
+        Dir.new 'temp'
+        expect('temp').to be_directory
+
+        Dir.delete 'temp'
+        expect('temp').not_to be_directory
+      end
+
+      specify "`.delete!` deletes a non-empty directory" do
+        Dir.new 'temp'
+        expect('temp').to be_directory
+
+        Dir.delete! 'temp'
+        expect('temp').not_to be_directory
+      end
+    end
+  end
+end

data/spec/fi/path_spec.rb

@@ -0,0 +1,20 @@
+require "fi/path"
+
+module Fi
+  RSpec.describe Path do
+    it "expands a relative path" do
+      path = Path.expand '~/'
+      expect(path).to eq "#{ENV['HOME']}"
+    end
+
+    it "joins paths" do
+      path = Path.join '~/', 'dir', 'file'
+      expect(path).to eq '~/dir/file'
+    end
+
+    it "joins then expands a path" do
+      path = Path.expand '~/', 'dir', 'file'
+      expect(path).to eq "#{ENV['HOME']}/dir/file"
+    end
+  end
+end

data/spec/fi_spec.rb

@@ -0,0 +1,36 @@
+require "fi"
+
+RSpec.describe Fi do
+  include SpecHelper::TempFiles
+
+  before(:each) { create_tempfiles }
+  after(:each)  { delete_tempfiles }
+
+  specify "open a file" do
+    file = Fi.open tempfile
+    expect(file).to be_a File
+  end
+
+  specify "open a file that doesn't exist" do
+    expect { Fi.open 'null.tmp' }.to raise_error
+  end
+
+  specify "read a file's content" do
+    content = Fi.read tempfile
+    expect(content).to eq 'test content'
+  end
+
+  specify "create a new file" do
+    file = Fi.new 'newfile.tmp', 'test content'
+    expect(file.content).to eq 'test content'
+  end
+
+  specify "delete a file" do
+    file = Fi.delete "newfile.tmp"
+    expect(file).to eq 1
+  end
+
+  specify "copy a file"
+  specify "create a link to a file"
+  specify "determine a type of a file"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,103 @@
+RSpec::Matchers.define :be_directory do |expected|
+  match do |actual|
+    Dir.exist? actual
+  end
+end
+
+RSpec::Matchers.define :with_hidden_files do |expected|
+  match do |actual|
+    true
+  end
+end
+
+module SpecHelper
+  module TempFiles
+    def tempfile
+      'testfile.tmp'
+    end
+
+    def create_tempfiles
+      ::File.open(tempfile, 'w+') do |f|
+        f.write "test content"
+      end
+    end
+
+    def delete_tempfiles
+      ::File.delete tempfile
+    end
+  end
+end
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # 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
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Slava Pavlutin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-10 00:00:00.000000000 Z
+date: 2015-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -46,13 +46,23 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- features/path.feature
 - fi.gemspec
 - lib/fi.rb
+- lib/fi/dir.rb
+- lib/fi/file.rb
+- lib/fi/path.rb
 - lib/fi/version.rb
+- spec/fi/dir_spec.rb
+- spec/fi/path_spec.rb
+- spec/fi_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -76,6 +86,11 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Working with files never was easier
-test_files: []
+summary: Working with files, easier.
+test_files:
+- features/path.feature
+- spec/fi/dir_spec.rb
+- spec/fi/path_spec.rb
+- spec/fi_spec.rb
+- spec/spec_helper.rb
 has_rdoc: