ferver 1.3.0 → 1.3.1

data/lib/ferver/file_list.rb

@@ -1,52 +1,28 @@
-require 'forwardable'
-
-# A representation of Ferver's file list
-#
+# frozen_string_literal: true
 module Ferver
+  # A representation of Ferver's file list
   class FileList
     include Enumerable
 
-    # Create a new instance with a path
+    # Create a new instance with given directory
     #
-    def initialize(path)
-      fail ArgumentError, 'No path is specified' if path.empty?
-      fail DirectoryNotFoundError unless Dir.exist?(path)
-
-      @configured_file_path = File.expand_path(path)
-      @files = find_files.sort_by! { |f| f.name.downcase }
+    def initialize(files)
+      @files = files.sort_by { |f| f.name.downcase }
     end
 
     def each(&block)
-      files.each(&block)
+      @files.each(&block)
     end
 
     def size
-      files.size
+      @files.size
     end
 
-    # Filename by its index
-    # An id out of range with raise IndexError
+    # Fetch a file by its index
+    # An id out of range with raise FileNotFoundError
     #
     def file_by_id(id)
-      files.fetch(id)
-    end
-
-    private
-
-    attr_reader :configured_file_path, :files
-
-    # Iterate through files in specified dir for files
-    #
-    def find_files
-      [].tap do |results|
-        Dir.foreach(configured_file_path) do |file_name|
-          next if file_name == '.' || file_name == '..'
-          next if file_name =~ /^\./ && !Ferver.configuration.serve_hidden?
-
-          found_file = FoundFile.new(configured_file_path, file_name)
-          results << found_file if found_file.valid?
-        end
-      end
+      @files.at(id) || raise(FileNotFoundError, "File id=#{id} not found")
     end
   end
 end

data/lib/ferver/found_file.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module Ferver
   class FoundFile
     attr_reader :file_name, :path_to_file
 
-    alias_method :name, :file_name
+    alias name file_name
 
     def initialize(directory, file_name)
       @file_name = file_name

data/lib/ferver/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ferver
-  VERSION = '1.3.0'
+  VERSION = "1.3.1".freeze
 end

data/spec/configuration_spec.rb

@@ -1,19 +1,18 @@
-require 'spec_helper'
-
-describe Ferver::Configuration do
+# frozen_string_literal: true
+RSpec.describe Ferver::Configuration do
   subject { described_class.new }
 
-  describe 'configured directory path' do
-    context 'with no path set' do
-      it 'should return default path' do
-        expect(subject.directory_path).to eq(Ferver::DEFAULT_FILE_SERVER_DIR_PATH)
+  describe "configured directory path" do
+    context "with no path set" do
+      it "should return default path" do
+        expect(subject.directory_path).to eq("./")
       end
     end
 
-    context 'when directory is set' do
-      let(:path) { '/foo/bar' }
+    context "when directory is set" do
+      let(:path) { "/foo/bar" }
 
-      it 'should return default path' do
+      it "should return default path" do
         subject.directory_path = path
 
         expect(subject.directory_path).to eq(path)
@@ -36,4 +35,11 @@ describe Ferver::Configuration do
       end
     end
   end
+
+  describe "#directory" do
+    it "is a FerverDirectory with configuration" do
+      expect(Ferver::FerverDirectory).to receive(:new).with(subject).and_call_original
+      expect(subject.directory).to be_instance_of Ferver::FerverDirectory
+    end
+  end
 end

data/spec/ferver_directory_spec.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+RSpec.describe Ferver::FerverDirectory do
+  subject { described_class.new config }
+
+  let(:config) { double("Ferver::Configuration", directory_path: path, serve_hidden?: serve_hidden) }
+  let(:path) { "/dev" }
+  let(:serve_hidden) { true }
+
+  before do
+    allow(Dir).to receive(:exist?).and_return true
+  end
+
+  describe "assertions" do
+    context "when path is empty" do
+      let(:path) { "" }
+
+      it "raises error" do
+        expect { described_class.new config }.to raise_error(ArgumentError, "No path is specified")
+      end
+    end
+
+    context "when directory does not exist" do
+      before do
+        allow(Dir).to receive(:exist?).and_return false
+      end
+
+      it "raises error" do
+        expect { described_class.new config }.to raise_error(Ferver::DirectoryNotFoundError)
+      end
+    end
+  end
+
+  describe "#path" do
+    let(:path) { "/dev/random" }
+
+    it "is the path from config" do
+      expect(subject.path).to eq "/dev/random"
+    end
+  end
+
+  describe "#full_path" do
+    let(:path) { "./" }
+
+    it "is the full path to directory" do
+      expect(File).to receive(:expand_path).with("./").and_return("/my/home")
+      expect(subject.full_path).to eq "/my/home"
+    end
+  end
+
+  describe "#found_files" do
+    before(:each) do
+      allow(Dir).to receive(:foreach)
+        .and_yield(".")
+        .and_yield("..")
+        .and_yield("zero file")
+        .and_yield("normal_file.txt")
+        .and_yield(".hidden")
+      allow(File).to receive(:file?).at_most(3).times.and_return(true, true, true)
+      allow(File).to receive(:zero?).at_most(3).times.and_return(true, false, false)
+    end
+
+    context "when configured to serve all files" do
+      let(:serve_hidden) { true }
+
+      it "returns list of files matched" do
+        expect(subject.found_files.map(&:name)).to eq ["normal_file.txt", ".hidden"]
+      end
+    end
+
+    context "when configured not to serve hidden files" do
+      let(:serve_hidden) { false }
+
+      it "returns list of files matched" do
+        expect(subject.found_files.map(&:name)).to eq ["normal_file.txt"]
+      end
+    end
+  end
+end

data/spec/ferver_spec.rb

@@ -1,18 +1,22 @@
-require 'spec_helper'
-
-describe 'ferver' do
-  let(:file_list) { double('Ferver::FileList') }
+# frozen_string_literal: true
+RSpec.describe "ferver" do
+  let(:ferver_directory) { double("Ferver::FerverDirectory", path: "/", full_path: "/path/to/files", found_files: []) }
+  before do
+    Ferver.configure do |conf|
+      conf.directory = ferver_directory
+    end
+  end
 
-  context 'given a request to the server root' do
+  context "given a request to the server root" do
     before do
-      get '/'
+      get "/"
     end
 
-    it 'should return redirect' do
+    it "should return redirect" do
       expect(last_response).to be_redirect
     end
 
-    it 'should redirect to file list' do
+    it "should redirect to file list" do
       follow_redirect!
 
       expect(last_response).to be_ok
@@ -20,130 +24,94 @@ describe 'ferver' do
     end
   end
 
-  describe 'choosing directory to serve files from' do
-    before do
-      allow(file_list).to receive(:each_with_index)
-      allow(file_list).to receive(:size).and_return(0)
-    end
-
-    context 'when no directory is specified' do
-      it 'will use default directory' do
-        expect(Ferver::FileList).to receive(:new).with('./').and_return(file_list)
-
-        get '/files'
-      end
-    end
-
-    context 'when the directory passed via configuration' do
+  describe "configuration error" do
+    context "when directory does not exist" do
       before do
-        Ferver.configure do |conf|
-          conf.directory_path = '/foo'
-        end
+        allow(ferver_directory).to receive(:found_files).and_raise(Ferver::DirectoryNotFoundError)
       end
 
-      it 'will use directory specified' do
-        expect(Ferver::FileList).to receive(:new).with('/foo').and_return(file_list)
-
-        get '/files'
-      end
-    end
-
-    context 'when directory does not exist' do
-      before do
-        allow(Ferver::FileList).to receive(:new).and_raise(Ferver::DirectoryNotFoundError)
-      end
-
-      it 'will return server error status' do
-        get '/files'
+      it "will return server error status" do
+        get "/files"
 
         expect(last_response.status).to eql 500
       end
     end
   end
 
-  context 'given an empty list of files' do
+  context "given an empty list of files" do
     before do
-      allow(file_list).to receive(:each_with_index)
-      allow(file_list).to receive(:size).and_return(0)
-      allow(Ferver::FileList).to receive(:new).and_return(file_list)
+      allow(ferver_directory).to receive(:found_files).and_return(EMPTY_FILE_LIST)
     end
 
-    context 'when no content-type is requested' do
-      before { get '/files' }
+    context "when no content-type is requested" do
+      before { get "/files" }
 
-      it 'should return valid response' do
+      it "should return valid response" do
         expect(last_response).to be_ok
       end
 
-      it 'should contain no file list in response content' do
-        expect(last_response.body).not_to have_tag('li')
-        expect(last_response.body).to have_tag('p', text: /0 files/)
+      it "should contain no file list in response content" do
+        expect(last_response.body).not_to have_tag("li")
+        expect(last_response.body).to have_tag("p", text: /0 files/)
       end
     end
 
-    context 'when json content-type is requested' do
+    context "when json content-type is requested" do
       before do
-        allow(file_list).to receive(:map).and_return([])
-
-        get '/files', {}, 'HTTP_ACCEPT' => 'application/json'
+        get "/files", {}, "HTTP_ACCEPT" => "application/json"
       end
 
-      it 'should return valid response' do
+      it "should return valid response" do
         expect(last_response).to be_ok
-        expect(last_response.content_type).to include('application/json')
+        expect(last_response.content_type).to include("application/json")
       end
 
-      it 'should contain no file list in response content' do
+      it "should contain no file list in response content" do
         list = JSON.parse last_response.body
         expect(list).to eq(EMPTY_FILE_LIST)
       end
     end
   end
 
-  context 'given a list of files' do
-    let(:file_1) { double('file', name: 'file1') }
-    let(:file_2) { double('file', name: 'file2') }
+  context "given a list of files" do
+    let(:file_1) { double("file", name: "file1") }
+    let(:file_2) { double("file", name: "file2") }
     before do
-      allow(file_list).to receive(:each_with_index).and_yield(file_1, 1).and_yield(file_2, 2)
-      allow(file_list).to receive(:size).and_return(2)
-      allow(Ferver::FileList).to receive(:new).and_return(file_list)
+      allow(ferver_directory).to receive(:found_files).and_return([file_1, file_2])
     end
 
-    describe 'file list request' do
-
-      context 'when no content-type is requested' do
-        before { get '/files' }
+    describe "file list request" do
+      context "when no content-type is requested" do
+        before { get "/files" }
 
-        it 'should return valid response' do
+        it "should return valid response" do
           expect(last_response).to be_ok
         end
 
-        it 'should contain no file list in response content' do
-          expect(last_response.body).to have_tag('li', count: 2)
-          expect(last_response.body).to have_tag('p', text: /2 files/)
+        it "should contain no file list in response content" do
+          expect(last_response.body).to have_tag("li", count: 2)
+          expect(last_response.body).to have_tag("p", text: /2 files/)
         end
 
-        it 'should list filenames' do
-          expect(last_response.body).to have_tag('li') do
-            with_tag('a', text: 'file1')
-            with_tag('a', text: 'file2')
+        it "should list filenames" do
+          expect(last_response.body).to have_tag("li") do
+            with_tag("a", text: "file1")
+            with_tag("a", text: "file2")
           end
         end
       end
 
-      context 'when json content-type is requested' do
+      context "when json content-type is requested" do
         before do
-          allow(file_list).to receive(:map).and_return([file_1.name, file_2.name])
-
-          get '/files', {}, 'HTTP_ACCEPT' => 'application/json'
+          get "/files", {}, "HTTP_ACCEPT" => "application/json"
         end
 
-        it 'should return valid response' do
+        it "should return valid response" do
           expect(last_response).to be_ok
-          expect(last_response.content_type).to include('application/json')
+          expect(last_response.content_type).to include("application/json")
         end
 
-        it 'should contain no file list in response content' do
+        it "should contain no file list in response content" do
           list = JSON.parse last_response.body
           expect(list.count).to eq(2)
           expect(list).to match_array([file_1.name, file_2.name])
@@ -151,38 +119,35 @@ describe 'ferver' do
       end
     end
 
-    describe 'downloading a file' do
-
-      context 'when requesting a file out of range' do
+    describe "downloading a file" do
+      context "when requesting a file out of range" do
         before do
-          allow(file_list).to receive(:file_by_id).with(3).and_raise(IndexError)
-          get '/files/3'
+          get "/files/3"
         end
 
-        it 'should return not_found' do
+        it "should return not_found" do
           expect(last_response).to be_not_found
         end
       end
 
-      context 'when requesting invalid file id' do
-        before { get '/files/foo' }
+      context "when requesting invalid file id" do
+        before { get "/files/foo" }
 
-        it 'should return not_found' do
+        it "should return not_found" do
           expect(last_response).to be_bad_request
         end
       end
 
-      context 'when requesting a valid file id' do
-        before { get '/files/0' }
+      context "when requesting a valid file id" do
+        before { get "/files/0" }
 
-        xit 'should return ok response' do
+        xit "should return ok response" do
           expect(last_response).to be_ok
         end
 
-        xit 'should return octet-stream content-type' do
-          expect(last_response.headers['Content-Type']).to eq('application/octet-stream')
+        xit "should return octet-stream content-type" do
+          expect(last_response.headers["Content-Type"]).to eq("application/octet-stream")
         end
-
       end
     end
   end