skadategems-dev 0.0.9

data/spec/skadategems/dev/remote/directory_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+require 'skadategems/dev/remote/directory'
+
+module SkadateGems::Dev
+  class Remote
+
+    describe Directory do
+      let(:remote) { double Remote, exec: nil }
+
+      describe '#initialize' do
+        let(:remote_dir) { Directory.new(remote, '/', 2244) }
+
+        it 'assigns a given @path value' do
+          expect(remote_dir.path).to eq '/'
+        end
+
+        it 'assigns a given @size value' do
+          expect(remote_dir.size).to eq 2244
+        end
+      end
+
+      describe '#basename' do
+        let(:remote_dir) do
+          Directory.new(remote, '/layout/themes/dp', 2244)
+        end
+
+        it 'returns the base name of a file' do
+          expect(remote_dir.basename).to eq 'dp'
+        end
+      end
+
+      describe '#list' do
+        let(:remote_dir) { Directory.new(remote, '/', 0) }
+        let(:script_batch) { double 'script batch', :<< => nil }
+        let(:response_body) { '[]' }
+        let(:response) { double 'http response',
+                                :code => 200,
+                                :message => 'OK',
+                                :body => response_body }
+
+        before(:each) do
+          allow(remote).to receive(:exec)
+              .and_yield(script_batch)
+              .and_return(response)
+        end
+
+        [
+          [ '/', '' ],
+          [ '/admin', 'admin' ],
+          [ '/admin/templates',  'admin/templates' ],
+          [ 'admin/templates/',  'admin/templates' ],
+          [ 'admin/templates',   'admin/templates' ],
+          [ '/admin/templates/', 'admin/templates' ]
+        ].each do |entry|
+          context "for `#{entry[0]}`" do
+            let(:remote_dir) { Directory.new(remote, entry[0], 0) }
+
+            it "requests dir(DIR_SITE_ROOT . '#{entry[1]}')" do
+              allow(script_batch).to receive(:<<) do |script|
+                expect(script).to include <<-PHPSCRIPT
+$dir = dir(DIR_SITE_ROOT . '#{entry[1]}');
+                PHPSCRIPT
+              end
+
+              remote_dir.list
+            end
+          end
+        end
+
+        context 'when a response is received' do
+          it 'parses it‘s body as a json' do
+            expect(JSON).to receive(:parse).with('[]').and_return []
+            expect(remote_dir.list).to eq []
+          end
+
+          context 'when the resulting json contains directory' do
+            let(:response_body) { '[ ["admin", "d", 3910] ]' }
+
+            it 'initializes it as a Remote::Directory instance' do
+              list_entry = remote_dir.list[0]
+
+              expect(list_entry).to be_a Directory
+              expect(list_entry.path).to eq '/admin'
+              expect(list_entry.size).to eq 3910
+            end
+          end
+
+          context 'when the resulting json contains a file' do
+            let(:response_body) { '[ ["index.php", "f", 204] ]' }
+
+            it 'initializes it as a Remote::File instance' do
+              list_entry = remote_dir.list[0]
+              expect(list_entry).to be_a(File)
+              expect(list_entry).not_to be_directory
+
+              expect(list_entry.path).to eq '/index.php'
+              expect(list_entry.size).to eq 204
+            end
+          end
+
+          context 'when the resulting json is a combination of directories and files' do
+            let(:response_body) do
+              '[ ["index.php", "f", 204], ["admin", "d", 3910], ["logo.jpg", "f", 13954] ]'
+            end
+
+            it 'orders the resulting @list of files by their `basename`' do
+              names = remote_dir.list.map(&:basename)
+              expect(names).to eq %w[admin index.php logo.jpg]
+            end
+          end
+        end
+
+      end
+    end
+
+  end
+end

data/spec/skadategems/dev/remote/file_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+require 'skadategems/dev/remote/file'
+
+module SkadateGems::Dev
+  describe Remote::File do
+    let(:remote) { double Remote, :exec => nil }
+
+    describe '#initialize' do
+      let(:remote_file) { Remote::File.new(remote, '/index.php', 204) }
+
+      it 'assigns @path' do
+        expect(remote_file.path).to eq '/index.php'
+      end
+
+      it 'assigns @size' do
+        expect(remote_file.size).to eq 204
+      end
+    end
+
+    describe '#basename' do
+      let(:remote_file) do
+        Remote::File.new(remote, '/internals/API/Layout.class.php', 2244)
+      end
+
+      it 'returns the base name of a file' do
+        expect(remote_file.basename).to eq 'Layout.class.php'
+      end
+    end
+
+    describe '#extname' do
+      let(:remote_file) do
+        Remote::File.new(remote, '/internals/API/Layout.class.php', 2244)
+      end
+
+      it 'returns the extension of a file' do
+        expect(remote_file.extname).to eq '.php'
+      end
+    end
+
+    describe '#friendly_size' do
+      let(:size) { nil }
+      let(:remote_file) { Remote::File.new(remote, '/image.png', size) }
+
+      subject { remote_file.friendly_size }
+
+      [ [0, '0 B'],
+
+        [512, '512 B'],
+        [513, '0.5 KiB'],
+        [767, '0.7 KiB'],
+
+        [1024, '1 KiB'],
+        [(1024 * 512), '512 KiB'],
+        [(1024 * 513), '0.5 MiB'],
+
+        [(1024 * 1024), '1 MiB'],
+        [(1024 * 1024 * 512), '512 MiB'],
+        [(1024 * 1024 * 513), '0.5 GiB'] ].each do |entry|
+        context "when @size = #{entry[0]}" do
+          let(:size) { entry[0] }
+          it { should eq entry[1] }
+        end
+      end
+    end
+
+    describe '#request' do
+      # @see integration/lib/remote/download_file_spec.rb
+    end
+
+    describe '#save_as' do
+      # ...
+    end
+  end
+end

data/spec/skadategems/dev/remote_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+require 'skadategems/dev/skadate'
+
+module SkadateGems
+  module Dev
+
+    describe Remote do
+
+      let(:accessor) do
+        double ExecPHP::RemoteServer,
+               execphp_uri: 'http://localhost/exec.php',
+               exec: nil
+      end
+
+      let(:remote) do
+        allow(ExecPHP::RemoteServer)
+            .to receive(:from_file)
+            .with('.dev/remote-server.json')
+            .and_return(accessor)
+
+        Remote.new('.dev/remote-server.json')
+      end
+
+      describe '#initialize' do
+        it 'instantiates a ExecPHP::RemoteServer' do
+          expect(remote.accessor).to equal(accessor)
+        end
+      end
+
+      describe '#directory' do
+        it 'returns a Remote::Directory with a given path' do
+          remote_dir = remote.directory '/internals'
+
+          expect(remote_dir).to be_a Remote::Directory
+          expect(remote_dir.path).to eq '/internals'
+        end
+      end
+
+      describe '#root' do
+        it 'returns a root Remote::Directory' do
+          root = remote.root
+
+          expect(root).to be_a Remote::Directory
+          expect(root.path).to eq '/'
+        end
+      end
+
+      # ...
+
+      describe '#userfiles' do
+        let(:response) do
+          double 'http response', code: '500',
+                                  message: 'Internal Server Error'
+        end
+
+        before(:each) do
+          allow(accessor).to receive(:exec).and_return(response)
+        end
+
+        context 'for `/$userfiles` case' do
+          let(:response) do
+            double 'http response', code: '200',
+                                    message: 'OK',
+                                    body: '/$userfiles'
+          end
+
+          it "returns a Remote::Directory(path: '/$userfiles')" do
+            userfiles = remote.userfiles
+
+            expect(userfiles).to be_a Remote::Directory
+            expect(userfiles.path).to eq '/$userfiles'
+          end
+        end
+
+        context 'for `/$userfiles` case' do
+          let(:response) do
+            double 'http response', code: '200',
+                                    message: 'OK',
+                                    body: '/userfiles'
+          end
+
+          it "returns a Remote::Directory(path: '/userfiles')" do
+            userfiles = remote.userfiles
+
+            expect(userfiles).to be_a Remote::Directory
+            expect(userfiles.path).to eq '/userfiles'
+          end
+        end
+
+      end
+
+    end
+
+  end
+end

data/spec/skadategems/dev/skadate_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+require 'skadategems/dev/skadate'
+
+module SkadateGems
+  module Dev
+
+    describe Skadate do
+      let(:skadate) { Skadate.new('/path/to/skadate') }
+
+      describe '#initialize' do
+        it 'assigns @root_dir' do
+          expect(skadate.root_dir).to eq '/path/to/skadate'
+        end
+      end
+
+      describe '#source' do
+        let(:source) { double(SourceController) }
+
+        it 'initializes a new source controller' do
+          expect(SourceController)
+            .to receive(:new)
+            .with('/path/to/skadate')
+
+          skadate.source
+        end
+
+        it 'always returns link to a single object' do
+          expect(SourceController)
+            .to receive(:new)
+            .once
+            .with('/path/to/skadate')
+            .and_return(source)
+            .and_return(source)
+
+          expect(skadate.source).to equal(skadate.source)
+        end
+      end
+
+      describe '#remote' do
+        let(:remote) { double(Remote) }
+
+        it 'initializes a remote accessor using the `remote-server.json` file' do
+          expect(Remote).to receive(:new)
+              .with('/path/to/skadate/.dev/remote-server.json')
+              .and_return(remote)
+
+          expect(skadate.remote).to equal(remote)
+        end
+
+        it 'always returns link to a single object' do
+          expect(Remote).to receive(:new)
+            .once
+            .with('/path/to/skadate/.dev/remote-server.json')
+            .and_return(remote)
+
+          expect(skadate.remote).to equal(remote)
+        end
+      end
+    end
+
+  end
+end

data/spec/skadategems/dev/software_version_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+require 'skadategems/dev/software_version'
+
+module SkadateGems
+  module Dev
+
+    describe SoftwareVersion do
+      let(:version) { SoftwareVersion.new('9.2.2960') }
+
+      describe '#initialize' do
+        it 'assigns @major' do
+          expect(version.major).to eq 9
+        end
+
+        it 'assigns @minor' do
+          expect(version.minor).to eq 2
+        end
+
+        it 'assigns @build' do
+          expect(version.build).to eq 2960
+        end
+      end
+
+      describe '#to_s' do
+        it 'returns string version representation' do
+          expect(version.to_s).to eq '9.2.2960'
+        end
+      end
+
+      describe '#==(other)' do
+        let(:version_a) { SoftwareVersion.new('9.2.2960') }
+
+        context 'when comparing with a string' do
+          context 'the same versions' do
+            let(:version_b) { '9.2.2960' }
+
+            it 'are equal' do
+              expect(version_a).to eq(version_b)
+            end
+          end
+
+          context 'a different versions' do
+            let(:version_b) { '9.0.2500' }
+
+            it 'are not equal' do
+              expect(version_a).to_not eq(version_b)
+            end
+          end
+        end
+
+        context 'when comparing with other version object' do
+          context 'the same versions' do
+            let(:version_b) { SoftwareVersion.new('9.2.2960') }
+
+            it 'are equal' do
+              expect(version_a).to eq(version_b)
+            end
+          end
+
+          context 'a different versions' do
+            let(:version_b) { SoftwareVersion.new('9.0.2500') }
+
+            it 'are not equal' do
+              expect(version_a).to_not eq(version_b)
+            end
+          end
+        end
+      end
+
+      describe '#supported?' do
+
+        context 'for supported version' do
+          let(:version) { SoftwareVersion.new('9.2.2960') }
+
+          it 'returns true' do
+            expect(version).to be_supported
+          end
+        end
+
+        context 'for unknown version' do
+          let(:version) { SoftwareVersion.new('3.2.123') }
+
+          it 'returns false' do
+            expect(version).not_to be_supported
+          end
+        end
+
+      end
+    end
+
+  end
+end

data/spec/skadategems/dev/source_controller_spec.rb

@@ -0,0 +1,243 @@
+require 'spec_helper'
+require 'skadategems/dev/source_controller'
+
+module SkadateGems
+  module Dev
+
+    describe SourceController do
+      let(:source) { SourceController.new('/path/to/skadate') }
+
+      describe '#initialize' do
+        it 'assigns @root' do
+          expect(source.root).to eq '/path/to/skadate'
+        end
+      end
+
+      describe '#filename' do
+        it 'returns a full path to a file' do
+          expect(source.filename('index.php')).to eq '/path/to/skadate/index.php'
+        end
+      end
+
+      describe '#version' do
+        context 'when the `#header_inc_php` file can not be found' do
+          before(:each) do
+            expect(source).to receive(:parse_version_definition).and_raise(Errno::ENOENT)
+          end
+
+          it "doesn't raise an error" do
+            expect { source.version }.to_not raise_error
+          end
+
+          it 'returns nil' do
+            expect(source.version).to be_nil
+          end
+        end
+
+        context 'when the version definition can not be parsed' do
+          before(:each) do
+            expect(source).to receive(:parse_version_definition).and_raise(SourceController::ParseError)
+          end
+
+          it "doesn't raise an error" do
+            expect { source.version }.to_not raise_error
+          end
+
+          it 'returns nil' do
+            expect(source.version).to be_nil
+          end
+        end
+
+        context 'when the `#header_inc_php` file is ok' do
+
+          context 'for supported version' do
+            before(:each) do
+              expect(source).to receive(:parse_version_definition).and_return('9.0.2500')
+            end
+
+            it 'returns a software version object' do
+              expect(source.version).to equal SoftwareVersion::MAP['9.0.2500']
+            end
+
+            it 'caches a returned value' do
+              source.version
+              expect(source).to_not receive(:parse_version_definition)
+              expect(source.version).to equal SoftwareVersion::MAP['9.0.2500']
+            end
+          end
+
+          context 'for unsupported version' do
+            before(:each) do
+              expect(source).to receive(:parse_version_definition).and_return('3.2.123')
+            end
+
+            it 'initializes a new software version object' do
+              version = source.version
+              expect(version).to be_a SoftwareVersion
+              expect(version).to eq '3.2.123'
+            end
+
+            it 'caches a returned value' do
+              source.version
+              expect(source).to_not receive(:parse_version_definition)
+              expect(source.version).to eq '3.2.123'
+            end
+          end
+        end
+      end
+
+      describe '#version!' do
+        context 'when the `#header_inc_php` file can not be found' do
+          before(:each) do
+            expect(source).to receive(:parse_version_definition).and_raise(Errno::ENOENT)
+          end
+
+          it 'raises an Errno::ENOENT' do
+            expect { source.version! }.to raise_error(Errno::ENOENT)
+          end
+        end
+
+        context 'when the version definition can not be parsed' do
+          before(:each) do
+            expect(source).to receive(:parse_version_definition).and_raise(SourceController::ParseError)
+          end
+
+          it 'raises a SourceController::ParseError' do
+            expect { source.version! }.to raise_error(SourceController::ParseError)
+          end
+        end
+
+        context 'when the `#header_inc_php` file is ok' do
+          context 'for supported version' do
+            it 'returns a software version object' do
+              expect(source).to receive(:parse_version_definition).and_return('9.0.2555')
+              expect(source.version!).to equal SoftwareVersion::MAP['9.0.2555']
+            end
+
+            it 'caches a returned value' do
+              expect(source).to receive(:parse_version_definition).once.and_return('9.0.2555')
+              source.version!
+              expect(source.version!).to equal SoftwareVersion::MAP['9.0.2555']
+            end
+          end
+
+          context 'for unsupported version' do
+            before(:each) do
+              expect(source).to receive(:parse_version_definition).and_return('3.2.123')
+            end
+
+            it 'raises a SoftwareVersion::CompatibilityError' do
+              expect { source.version! }.to raise_error(SoftwareVersion::CompatibilityError)
+            end
+          end
+        end
+      end
+
+      describe '#parse_version_definition' do
+        let(:file) { double(File, read: file_contents) }
+        let(:header_filename) { '/path/to/skadate/internals/Header.inc.php' }
+
+        context 'when the `#header_inc_php` file can not be found' do
+          before(:each) do
+            expect(File).to receive(:open).with(header_filename).and_raise(Errno::ENOENT)
+          end
+
+          it 'raises an Errno::ENOENT' do
+            expect { source.parse_version_definition }.to raise_error(Errno::ENOENT)
+          end
+        end
+
+        context 'when the version definition can not be parsed' do
+          let(:file_contents) { "<?php ... ?>\n" }
+
+          before(:each) do
+            expect(File).to receive(:open).with(header_filename) do |&block|
+              block.call(file)
+            end
+          end
+
+          it 'raises a SourceController::ParseError' do
+            expect {source.parse_version_definition}.to raise_error(SourceController::ParseError)
+          end
+        end
+
+        context 'when the `#header_inc_php` file is ok' do
+          let(:file_contents) do
+            <<-PHPSCRIPT
+<?php define('PACKAGE_VERSION', '9.2.2657'); ?>
+            PHPSCRIPT
+          end
+
+          before(:each) do
+            expect(File).to receive(:open)
+                            .with(header_filename) do |&block|
+              block.call(file)
+            end
+          end
+
+          it 'parses the file and returns a version definition' do
+            expect(source.parse_version_definition).to eq '9.2.2657'
+          end
+        end
+      end
+
+      %w[internal_c external_c userfiles].each do |dirname|
+
+        describe "##{dirname}" do
+          context 'for a version earlier than `9.2.2960`' do
+            let(:version) { SoftwareVersion::MAP['9.2.2657'] }
+
+            before(:each) do
+              expect(source).to receive(:version!).and_return(version)
+            end
+
+            it "returns `/path/to/skadate/$#{dirname}`" do
+              expect(source.send(dirname.to_sym)).to eq "/path/to/skadate/$#{dirname}"
+            end
+          end
+
+          context 'for version `9.2.2960` and above' do
+            let(:version) { SoftwareVersion::MAP['9.2.2960'] }
+
+            before(:each) do
+              expect(source).to receive(:version!).and_return(version)
+            end
+
+            it "returns `/path/to/skadate/#{dirname}`" do
+              expect(source.send(dirname.to_sym)).to eq "/path/to/skadate/#{dirname}"
+            end
+          end
+        end
+
+      end
+
+      describe '#config_php' do
+
+        context 'for a version earlier than `9.2.2960`' do
+          let(:version) { SoftwareVersion::MAP['9.2.2657'] }
+
+          before(:each) do
+            expect(source).to receive(:version!).and_return(version)
+          end
+
+          it 'returns `/path/to/skadate/internals/$config.php`' do
+            expect(source.config_php).to eq '/path/to/skadate/internals/$config.php'
+          end
+        end
+
+        context 'for version `9.2.2960` and above' do
+          let(:version) { SoftwareVersion::MAP['9.2.2960'] }
+
+          before(:each) do
+            expect(source).to receive(:version!).and_return(version)
+          end
+
+          it 'returns `/path/to/skadate/internals/config.php`' do
+            expect(source.config_php).to eq '/path/to/skadate/internals/config.php'
+          end
+        end
+      end
+    end
+
+  end
+end