voog-kit 0.1.8

data/spec/models/dtk/filemanager_spec.rb

@@ -0,0 +1,524 @@
+require 'spec_helper'
+require 'fileutils'
+require 'json'
+require 'ostruct'
+
+describe Voog::Dtk::FileManager do
+  before :all do
+    Dir.mkdir 'TEST'
+    Dir.chdir 'TEST'
+    @filemanager = Voog::Dtk::FileManager.new(nil, false, true)
+    @dir = Dir.new('.')
+  end
+
+  describe '#create_asset' do
+    before :each do
+      @filemanager.create_folders
+    end
+
+    after :each do
+      FileUtils.rm_r Dir['**']
+      @filemanager.create_folders
+    end
+
+    context 'with no asset provided' do
+      it 'does not create any new files' do
+        @old_count = Dir['**/*'].length
+        @filemanager.create_asset
+        @new_count = Dir['**/*'].length
+        expect(@new_count).to eq(@old_count)
+      end
+    end
+
+    context 'with an invalid asset provided' do
+      it 'does not create any new files' do
+        @old_files = Dir['**/*']
+        @filemanager.create_asset OpenStruct.new(filename: '', asset_type: 'stylesheet')
+        @new_files = Dir['**/*']
+        expect((@new_files - @old_files).count).to eq(0)
+      end
+    end
+
+    context 'with a valid asset provided' do
+      before :each do
+        @old_files = Dir['**/*']
+        @filemanager.create_asset get_layout_asset
+        @new_files = Dir['**/*']
+      end
+      it 'creates a new file in the file system' do
+        expect(@new_files.count).to eq(@old_files.count + 1)
+      end
+
+      it 'creates a file with the same contents as the provided asset' do
+        expect(File.read(Dir.getwd + '/stylesheets/test.css')).to eq('test data')
+      end
+
+      it 'creates a file with the same name as the provided asset' do
+        expect(@new_files - @old_files).to eq(['stylesheets/test.css'])
+      end
+    end
+  end
+
+  describe '#create_layout' do
+    before :each do
+      @filemanager.create_folders
+    end
+
+    after :each do
+      FileUtils.rm_r Dir['**']
+      @filemanager.create_folders
+    end
+
+    context 'with no layout provided' do
+      it 'does not create any new files' do
+        @old_files = Dir['**/*']
+        @filemanager.create_asset
+        @new_files = Dir['**/*']
+        expect((@new_files - @old_files).count).to eq(0)
+      end
+    end
+
+    context 'with an invalid layout provided' do
+      it 'does not create any new files' do
+        @old_files = Dir['**/*']
+        @filemanager.create_asset OpenStruct.new('component' => nil, 'body' => false)
+        @new_files = Dir['**/*']
+        expect((@new_files - @old_files).count).to eq(0)
+      end
+    end
+
+    context 'with a valid layout provided' do
+      before :each do
+        @old_files = Dir['**/*']
+        @filemanager.create_layout get_layout
+        @new_files = Dir['**/*']
+      end
+
+      it 'creates a new file in the file system' do
+        expect(@new_files.count).to eq(@old_files.count + 1)
+      end
+
+      it 'creates a file with the same contents as the provided asset' do
+        expect(File.read(Dir.getwd + '/components/test.tpl')).to eq('test body')
+      end
+
+      it 'creates a file with the same name as the provided asset' do
+        expect(@new_files - @old_files).to eq(['components/test.tpl'])
+      end
+    end
+  end
+
+  describe '#create_folders' do
+
+    it 'creates all folders in the given list' do
+      @filemanager.create_folders
+      folders = %w(stylesheets images assets javascripts components layouts)
+      # check if the folders array is a subset of current directory's contents
+      expect((@dir.entries & folders).length).to eq(folders.length)
+    end
+  end
+
+  describe '#valid?' do
+    context 'with malformed data' do
+      it 'returns false' do
+        expect(@filemanager.valid?('{[...  )')).to be false
+      end
+    end
+
+    context 'with empty' do
+      it 'returns false' do
+        expect(@filemanager.valid?('{}')).to be false
+      end
+    end
+
+    context 'with invalid data' do
+      it 'returns false' do
+        data = get_layouts
+        data.first.delete_field('title')
+        expect(@filemanager.valid?(data)).to be false
+      end
+    end
+
+    context 'with valid data' do
+      it 'returns true' do
+        expect(@filemanager.valid?(get_layouts)).to be true
+      end
+    end
+  end
+
+  describe '#generate_manifest' do
+    context 'with empty data' do
+      it 'doesn\'t generate a "manifest.json" file' do
+        @filemanager.generate_manifest(Hash.new, Hash.new)
+        expect(@dir.entries.include?('manifest.json')).to be false
+      end
+    end
+
+    context 'with valid data' do
+      let(:layouts) { get_layouts }
+      let(:layout_assets) { get_layout_assets }
+
+      it 'generates a "manifest.json" file' do
+        @filemanager.generate_manifest(layouts, layout_assets)
+        expect(@dir.entries.include?('manifest.json')).to be true
+      end
+
+      it 'writes valid data into "manifest.json"' do
+        @filemanager.generate_manifest(layouts, layout_assets)
+        @manifest = @filemanager.read_manifest
+        expect(@manifest['layouts'].first['title']).to eq(get_layouts.first.title)
+        expect(@manifest['assets'].first['content_type']).to eq(get_layout_assets.first.content_type)
+      end
+    end
+
+    context 'with invalid data' do
+      let(:layouts) { '"foo: { ]' }
+      let(:layout_assets) { 'bar": [.. )' }
+
+      it 'returns false' do
+        expect(@filemanager.generate_manifest(layouts, layout_assets)).to be false
+      end
+    end
+
+  end
+
+  describe '#add_to_manifest' do
+    before do
+      @filemanager.generate_manifest(get_layouts, get_layout_assets)
+      @old_manifest = @filemanager.read_manifest
+    end
+    context 'with empty data' do
+      it 'doesn\'t change the manifest file' do
+        @filemanager.add_to_manifest
+        @manifest = @filemanager.read_manifest
+        expect(@manifest['layouts'].length).to eq(@old_manifest['layouts'].length)
+      end
+    end
+
+    context 'with existing data' do
+      it 'doesn\'t add a duplicate file' do
+        testfiles = ['components/test_layout.tpl', 'layouts/testfile.tpl']
+        @filemanager.add_to_manifest testfiles
+        @manifest = @filemanager.read_manifest
+        expect(
+          @manifest['layouts'].select { |l| l['file'] == 'components/test_layout.tpl'}.length
+        ).to eq(1)
+      end
+    end
+
+    context 'with a single valid filename' do
+      it 'creates a new layout in the manifest' do
+        @filemanager.add_to_manifest 'components/testfile.tpl'
+        @manifest = @filemanager.read_manifest
+        expect(@manifest['layouts'].length).to eq(2)
+      end
+
+      it 'adds the correct data for the new layout' do
+        testfile = 'components/testfile.tpl'
+        @filemanager.add_to_manifest testfile
+        @manifest = @filemanager.read_manifest
+        new_layout = @manifest['layouts'].find{|l| l['file'] == testfile}
+        layout = {
+          'content_type' => 'component',
+          'component' => true,
+          'file' => 'components/testfile.tpl',
+          'layout_name' => 'testfile',
+          'title' => 'testfile'
+        }
+        expect(new_layout).to eq(layout)
+      end
+    end
+
+    context 'with multiple valid filenames' do
+      it 'adds new layouts to the manifest file' do
+        testfiles = ['components/testfile2.tpl', 'components/testfile3.tpl']
+        @filemanager.add_to_manifest testfiles
+        @manifest = @filemanager.read_manifest
+        expect(@manifest['layouts'].length).to eq(1 + testfiles.length)
+      end
+
+      it 'adds the correct data for the new layouts' do
+        testfiles = ['components/testfile2.tpl', 'layouts/testfile3.tpl']
+        @filemanager.add_to_manifest testfiles
+        @manifest = @filemanager.read_manifest
+        new_layout = @manifest['layouts'].last
+        expect(new_layout).to eq(
+          'content_type' => 'page',
+          'component' => false,
+          'file' => 'layouts/testfile3.tpl',
+          'layout_name' => 'testfile3',
+          'title' => 'Testfile3'
+        )
+      end
+    end
+
+    context 'with both valid and invalid filenames' do
+      it 'adds only valid files to the manifest' do
+        @old_manifest = @filemanager.read_manifest
+        testfiles = ['components/testfile2.tpl', 'javascripts/testfile.js', 'invalid/file']
+        @filemanager.add_to_manifest testfiles
+        @manifest = @filemanager.read_manifest
+        expect(@manifest['layouts'].length).to eq(@old_manifest['layouts'].length + 1)
+        expect(@manifest['assets'].length).to eq(@old_manifest['assets'].length + 1)
+      end
+
+      it 'does not add invalid files to the manifest' do
+
+      end
+    end
+  end
+
+  describe '#in_manifest?' do
+    before :all do
+      @manifest = JSON.parse(File.read(FIXTURE_PATH + '/manifest.json'))
+    end
+    context 'with a valid filename' do
+      it 'returns true if the file is in the manifest' do
+        filename = 'components/test_component.tpl'
+        expect(@filemanager.in_manifest?(filename, @manifest)).to eq(true)
+      end
+      it 'returns false if the file is not in the manifest' do
+        filename = 'components/wrong_file.tpl'
+        expect(@filemanager.in_manifest?(filename, @manifest)).to be_false
+      end
+    end
+  end
+
+  describe '#remove_from_manifest', focus: true do
+    before :all do
+      @filemanager.generate_manifest(get_layouts, get_layout_assets)
+      @filemanager.add_to_manifest ['components/testfile2.tpl', 'assets/test.svg']
+      @old_manifest = @filemanager.read_manifest
+    end
+
+    context 'with empty data' do
+      it 'doesn\'t remove anything from the manifest' do
+        @filemanager.remove_from_manifest
+        @manifest = @filemanager.read_manifest
+        expect(@manifest['layouts'].length).to eq(@old_manifest['layouts'].length)
+      end
+    end
+
+    context 'with invalid data' do
+      it 'doesn\'t remove anything from the manifest' do
+        @filemanager.remove_from_manifest 'files/testfile2.tpl'
+        @manifest = @filemanager.read_manifest
+        expect(@manifest['layouts'].length).to eq(@old_manifest['layouts'].length)
+      end
+    end
+
+    context 'with valid data' do
+      it 'removes the provided layouts from the manifest' do
+        @filemanager.remove_from_manifest ['components/testfile2.tpl', 'assets/test.svg']
+        @manifest = @filemanager.read_manifest
+        expect(@manifest['layouts'].length).to eq(@old_manifest['layouts'].length - 1)
+        expect(@manifest['assets'].length).to eq(@old_manifest['assets'].length - 1)
+      end
+    end
+  end
+
+  describe '#check' do
+    context 'with an empty folder' do
+      it 'returns false' do
+        expect(@filemanager.check).to be_false
+      end
+    end
+
+    context 'with empty manifest.json but no files' do
+      it 'returns false' do
+        File.open('manifest.json', 'w+') do |file|
+          file << {
+            'layouts' => [],
+            'assets' => []
+          }.to_json
+        end
+        expect(@filemanager.check).to be_false
+      end
+    end
+
+    context 'with filled manifest.json but no files' do
+      it 'returns false' do
+        File.open('manifest.json', 'w+') do |file|
+          file << {
+            'layouts' => [{
+              "component" => false,
+              "content_type" => "page",
+              "file" => "layouts/front_page.tpl",
+              "layout_name" => "page_front",
+              "title" => "Front page"
+            }],
+            'assets' => []
+          }.to_json
+        end
+        expect(@filemanager.check).to be_false
+      end
+    end
+  end
+
+  describe '#generate_local_manifest' do
+    before :each do
+      Dir.mkdir 'TEST'
+      Dir.chdir 'TEST'
+    end
+
+    after :each do
+      Dir.chdir '..'
+      FileUtils.rm_r 'TEST'
+    end
+
+    context 'with no local files or folders' do
+      before :each do
+        @dir = Dir.new('.')
+        @prev_entries = @dir.entries
+      end
+
+      after :each do
+        FileUtils.rm 'manifest.json' if File.exists? 'manifest.jsons'
+      end
+
+      it 'returns false' do
+        expect(@filemanager.generate_local_manifest).to be_false
+      end
+
+      it 'doesn\'t generate a manifest.json file' do
+        @filemanager.generate_local_manifest
+        expect(@dir.entries.length).to eq(@prev_entries.length)
+      end
+    end
+
+    context 'with empty folders' do
+      before :each do
+        FileUtils.mkdir 'layouts'
+        FileUtils.mkdir 'components'
+      end
+
+      after :each do
+        FileUtils.rm_r 'layouts'
+        FileUtils.rm_r 'components'
+        FileUtils.rm_r 'manifest.json' if File.exists? 'manifest.json'
+      end
+
+      it 'generates a manifest file' do
+        @filemanager.generate_local_manifest
+        expect(File.exists? 'manifest.json').to be_true
+        @manifest = @filemanager.read_manifest
+      end
+
+      it 'adds no layouts or components to the manifest' do
+        @filemanager.generate_local_manifest
+        @manifest = @filemanager.read_manifest
+        expect(@manifest['layouts'].length).to eq(0)
+      end
+
+      it 'returns true' do
+        expect(@filemanager.generate_local_manifest).to be_true
+      end
+    end
+
+    context 'with layout files' do
+      before :each do
+        FileUtils.mkdir ('layouts')
+        FileUtils.mkdir ('components')
+        File.open('layouts/front_page.tpl', 'w+')
+      end
+
+      after :each do
+        FileUtils.rm('layouts/front_page.tpl')
+        FileUtils.rm_r 'layouts'
+        FileUtils.rm_r 'components'
+      end
+
+      it 'adds the files to the manifest' do
+        @filemanager.generate_local_manifest
+        @manifest = @filemanager.read_manifest
+        expect(@manifest['layouts'].length).to eq(1)
+      end
+
+      it 'adds the files in a correct format to the manifest' do
+        @filemanager.generate_local_manifest
+        @manifest = @filemanager.read_manifest
+        layout = @manifest['layouts'].first
+        expect(layout['component']).to be_false
+        expect(layout['content_type']).to eq('page')
+        expect(layout['file']).to eq('layouts/front_page.tpl')
+        expect(layout['layout_name']).to eq('page_default')
+        expect(layout['title']).to eq('Front page')
+      end
+
+      it 'returns true' do
+        expect(@filemanager.generate_local_manifest).to be_true
+      end
+    end
+  end
+
+  describe '#fetch_boilerplate' do
+    context 'with no files in the working directory' do
+      before :each do
+        @prev_files = Dir['*']
+      end
+
+      after :each do
+        Dir['*'].each do |f|
+          FileUtils.rm_r f
+        end
+      end
+
+      it 'downloads and copies the boilerplate files' do
+        @filemanager.fetch_boilerplate
+        @files = Dir['*']
+        expected_files = [
+          'assets', 'images',
+          'components', 'javascripts',
+          'layouts', 'stylesheets',
+          'manifest.json'
+        ]
+        expect(expected_files & @files).to eq(expected_files)
+      end
+
+      it 'removes the \'tmp\' directory' do
+        @filemanager.fetch_boilerplate
+        @files = Dir['*']
+        expect(@files.include? 'tmp').to be_false
+      end
+
+      it 'returns true' do
+        expect(@filemanager.fetch_boilerplate).to be_true
+      end
+    end
+
+    context 'with files in the working directory' do
+      before :all do
+        @prev_files = Dir['*']
+        File.open('test.txt', 'w+')
+        File.open('manifest.json', 'w+') do |file| file << "[]" end
+        @old_manifest = File.open('manifest.json')
+        Dir.mkdir('test')
+        @return_value = @filemanager.fetch_boilerplate
+        @manifest = File.open('manifest.json')
+      end
+
+      after :all do
+        Dir['*'].each do |f|
+          FileUtils.rm_r f
+        end
+      end
+
+      it 'overwrites existing files' do
+        expect(@old_manifest.size).not_to eq(@manifest.size)
+      end
+
+      it 'doesn\'t modify other files' do
+        expect(@old_manifest.stat.mtime).not_to eq(@manifest.stat.mtime)
+      end
+
+      it 'returns true' do
+        expect(@return_value).to be_true
+      end
+    end
+  end
+
+  after :all do
+    Dir.chdir '..'
+    FileUtils.rm_r 'TEST'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+require_relative '../lib/voog/dtk.rb'
+require_relative '../lib/voog/dtk/filemanager.rb'
+require_relative '../lib/voog/dtk/notifier.rb'
+
+RSpec.configure do |c|
+  # filter_run is short-form alias for filter_run_including
+  c.filter_run focus: true
+end
+
+FIXTURE_PATH = File.expand_path(File.join(File.dirname(__FILE__), 'fixtures'))
+
+def get_layouts
+  JSON.parse(File.read(FIXTURE_PATH + '/layouts.json')).map do |layout|
+    OpenStruct.new(layout.to_h)
+  end
+end
+
+def get_layout_assets
+  JSON.parse(File.read(FIXTURE_PATH + '/layout_assets.json')).map do |asset|
+    OpenStruct.new(asset.to_h)
+  end
+end
+
+def get_layout_asset
+  OpenStruct.new(
+    JSON.parse(
+      File.read(FIXTURE_PATH + '/layout_asset.json')
+    ).to_h
+  )
+end
+
+def get_layout
+  OpenStruct.new(
+    JSON.parse(
+      File.read(FIXTURE_PATH + '/layout.json')
+    ).to_h
+  )
+end

data/voog-kit.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'voog/dtk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'voog-kit'
+  spec.version       = Voog::Dtk::VERSION
+  spec.authors       = ['Mikk Pristavka', 'Priit Haamer']
+  spec.email         = ['mikk@fraktal.ee', 'priit@voog.com']
+  spec.description   = %q{Tools that help Voog design development}
+  spec.summary       = %q{Voog Developer Toolkit}
+  spec.homepage      = 'http://voog.com/developers/voog-kit'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  spec.bindir        = 'bin'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  
+  spec.add_runtime_dependency 'gli', '2.10.0'
+  spec.add_runtime_dependency 'pry', '~> 0.9.12'
+  spec.add_runtime_dependency 'guard', '~> 2.3.0'
+  spec.add_runtime_dependency 'git'
+  spec.add_runtime_dependency 'parseconfig'
+  spec.add_runtime_dependency 'voog_api', '~> 0.0.7'
+  spec.add_runtime_dependency 'colorize'
+  spec.add_runtime_dependency 'mime-types', '~> 1.25.1'
+end