vedeu_cli 0.0.1

data/lib/vedeu/cli/view.rb

@@ -0,0 +1,86 @@
+module Vedeu
+
+  module CLI
+
+    # Generates a view for the client application.
+    #
+    # @example
+    #   ```bash
+    #   vedeu view main_screen
+    #   ```
+    #
+    # :nocov:
+    class View
+
+      include Vedeu::CLI::Helpers
+
+      # @see Vedeu::CLI::View#initialize
+      def self.generate(name)
+        new(name).generate
+      end
+
+      # Returns a new instance of Vedeu::CLI::View.
+      #
+      # @param name [String] The name of the view.
+      # @return [Vedeu::CLI::View]
+      def initialize(name)
+        @name = name
+      end
+
+      # @return [void]
+      def generate
+        make_controller_file
+        make_helper_file
+        make_keymap_file
+        make_interface_file
+        make_template_file
+        make_view_class_file
+
+        output("Please update the 'root' setting in 'config/configuration.rb'" \
+               " to '#{app_name}::#{name_as_class}Controller.new' to start " \
+               'Vedeu at this controller.')
+      end
+
+      private
+
+      # @return [void]
+      def make_controller_file
+        make_file(source + '/app/controllers/name.erb',
+                  '.' + "/app/controllers/#{name}_controller.rb")
+      end
+
+      # @return [void]
+      def make_helper_file
+        make_file(source + '/app/helpers/name.erb',
+                  '.' + "/app/helpers/#{name}_helper.rb")
+      end
+
+      # @return [void]
+      def make_keymap_file
+        make_file(source + '/app/models/keymaps/name.erb',
+                  '.' + "/app/models/keymaps/#{name}.rb")
+      end
+
+      # @return [void]
+      def make_interface_file
+        make_file(source + '/app/views/interfaces/name.erb',
+                  '.' + "/app/views/interfaces/#{name}.rb")
+      end
+
+      # @return [void]
+      def make_template_file
+        touch_file('.' + "/app/views/templates/#{name}.erb")
+      end
+
+      # @return [void]
+      def make_view_class_file
+        make_file(source + '/app/views/name.erb',
+                  '.' + "/app/views/#{name}.rb")
+      end
+
+    end # View
+    # :nocov:
+
+  end # CLI
+
+end # Vedeu

data/lib/vedeu_cli.rb

@@ -0,0 +1,21 @@
+require 'thor'
+require 'vedeu'
+
+require 'vedeu/cli/version'
+require 'vedeu/cli/helpers'
+require 'vedeu/cli/application'
+require 'vedeu/cli/view'
+require 'vedeu/cli/main'
+
+# Vedeu is a GUI framework for terminal/console applications written in Ruby.
+#
+module Vedeu
+
+  # Vedeu plugin to provide the mechanism to build client application code
+  # suitable for use with Vedeu.
+  #
+  module CLI
+
+  end # CLI
+
+end # Vedeu

data/test/lib/vedeu/cli/application_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+module Vedeu
+
+  module CLI
+
+    describe Application do
+
+      let(:described) { Vedeu::CLI::Application }
+      let(:instance)  { described.new(_name) }
+      let(:_name)     { 'my_first_app' }
+
+      describe '#initialize' do
+        it { instance.must_be_instance_of(described) }
+        it { instance.instance_variable_get('@name').must_equal(_name) }
+      end
+
+      describe '.generate' do
+        # before do
+        #   FileUtils.stubs(:cp_r)
+        #   FileUtils.stubs(:mkdir)
+        # end
+
+        subject { instance.generate(_name) }
+
+        # @todo Add more tests.
+      end
+
+      describe '#generate' do
+        it { instance.must_respond_to(:generate) }
+      end
+
+    end # Application
+
+  end # CLI
+
+end # Vedeu

data/test/lib/vedeu/cli/helpers_test.rb

@@ -0,0 +1,197 @@
+require 'test_helper'
+
+module Vedeu
+
+  module CLI
+
+    class HelpersTestClass
+
+      include Vedeu::CLI::Helpers
+
+      def initialize(name)
+        @name = name
+      end
+
+    end # HelpersTestClass
+
+    describe Helpers do
+
+      let(:described) { Vedeu::CLI::Helpers }
+      let(:instance)  { Vedeu::CLI::HelpersTestClass.new(_name) }
+      let(:_name)     { 'my_first_app' }
+
+      describe '#app_name' do
+        before { File.stubs(:read).returns('MyFirstApp') }
+
+        subject { instance.app_name }
+
+        it { subject.must_equal('MyFirstApp') }
+      end
+
+      describe '#make_directory' do
+        let(:destination) {}
+
+        before { Vedeu.stubs(:log_stdout) }
+
+        subject { instance.make_directory(destination) }
+
+        it {
+          FileUtils.expects(:mkdir_p).with(destination)
+          subject
+        }
+      end
+
+      describe '#copy_file' do
+        let(:source)      {}
+        let(:destination) {}
+
+        before {
+          File.stubs(:exist?).returns(false)
+          Vedeu.stubs(:log_stdout)
+        }
+
+        subject { instance.copy_file(source, destination) }
+
+        context 'when the file exists' do
+          before { File.stubs(:exist?).returns(true) }
+
+          it {
+            Vedeu.expects(:log_stdout)
+            subject
+          }
+        end
+
+        context 'when the file does not exist' do
+          it {
+            FileUtils.expects(:cp).with(source, destination)
+            subject
+          }
+        end
+      end
+
+      describe '#make_file' do
+        let(:source)      {}
+        let(:destination) {}
+
+        before {
+          File.stubs(:exist?).returns(false)
+          Vedeu.stubs(:log_stdout)
+        }
+
+        subject { instance.make_file(source, destination) }
+
+        context 'when the file exists' do
+          before { File.stubs(:exist?).returns(true) }
+
+          it {
+            Vedeu.expects(:log_stdout)
+            subject
+          }
+        end
+
+        context 'when the file does not exist' do
+          # @todo Add more tests.
+          # it { skip }
+        end
+      end
+
+      describe '#skipped_file' do
+        let(:destination) { 'some_file.txt' }
+
+        before { Vedeu.stubs(:log_stdout) }
+
+        subject { instance.skipped_file(destination) }
+
+        it {
+          Vedeu.expects(:log_stdout).
+            with(type:    :create,
+                 message: "some_file.txt \e[31malready exists, skipped.\e[39m")
+          subject
+        }
+      end
+
+      describe '#touch_file' do
+        let(:destination) {}
+
+        before { Vedeu.stubs(:log_stdout) }
+
+        subject { instance.touch_file(destination) }
+
+        it {
+          FileUtils.expects(:touch).with(destination)
+          subject
+        }
+      end
+
+      describe '#name' do
+        let(:_name) { 'My_First_APP' }
+
+        subject { instance.name }
+
+        it { subject.must_be_instance_of(String) }
+
+        it { subject.must_equal('my_first_app') }
+      end
+
+      describe '#name_as_class' do
+        subject { instance.name_as_class }
+
+        context 'when the name is a single value' do
+          let(:_name) { 'VEDEU' }
+
+          it { subject.must_equal('Vedeu') }
+        end
+
+        context 'when the name is an underscored value' do
+          it { subject.must_equal('MyFirstApp') }
+        end
+
+        context 'when the name contains hyphens' do
+          let(:_name) { 'hyphenated-APP' }
+
+          it { subject.must_equal('HyphenatedApp')}
+        end
+      end
+
+      describe '#output' do
+        let(:_message) { 'This is a test message.' }
+
+        before { Vedeu.stubs(:log_stdout) }
+
+        subject { instance.output(_message) }
+
+        it { subject.must_be_instance_of(String) }
+
+        it {
+          Vedeu.expects(:log_stdout).
+            with(type: :info, message: _message)
+          subject
+        }
+
+        it { subject.must_equal(_message) }
+      end
+
+      describe '#parse' do
+        let(:source) {}
+
+        subject { instance.parse(source) }
+
+        it {
+          Vedeu::Templating::Template.expects(:parse).with(instance, source)
+          subject
+        }
+      end
+
+      describe '#source' do
+        subject { instance.source }
+
+        it { subject.must_be_instance_of(String) }
+
+        it { subject.must_match('vedeu/cli/templates/application/.') }
+      end
+
+    end # Helpers
+
+  end # CLI
+
+end # Vedeu

data/test/lib/vedeu/cli/main_test.rb

@@ -0,0 +1,60 @@
+require 'test_helper'
+
+module Vedeu
+
+  module CLI
+
+    describe Main do
+
+      let(:described) { Vedeu::CLI::Main }
+      let(:instance)  { described.new }
+
+      # describe '#new' do
+      #   let(:_name) { 'app_name' }
+
+      #   before do
+      #     instance.stubs(:say).returns('')
+      #     Vedeu::CLI::Application.stubs(:generate).returns('')
+      #   end
+
+      #   subject { instance.new(_name) }
+
+      #   it {
+      #     instance.expects(:say)
+      #     subject
+      #   }
+      # end
+
+      # describe '#view' do
+      #   let(:_name) { 'view_name' }
+
+      #   before do
+      #     instance.stubs(:say).returns('')
+      #     Vedeu::CLI::View.stubs(:generate).returns('')
+      #   end
+
+      #   subject { instance.view(_name) }
+
+      #   it {
+      #     Vedeu::CLI::View.expects(:generate).with(_name)
+      #     subject
+      #   }
+      # end
+
+      describe '#version' do
+        before { instance.stubs(:say) }
+
+        subject { instance.version }
+
+        it {
+          instance.expects(:say)
+            #.with("vedeu #{Vedeu::VERSION} (vedeu_cli #{Vedeu::CLI::VERSION})")
+          subject
+        }
+      end
+
+    end # Main
+
+  end # CLI
+
+end # Vedeu

data/test/lib/vedeu/cli/version_test.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+module Vedeu
+
+  module CLI
+
+    # @todo Add more tests.
+    # it { skip }
+
+  end # CLI
+
+end # Vedeu

data/test/lib/vedeu/cli/view_test.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+
+module Vedeu
+
+  module CLI
+
+    describe View do
+
+      let(:described) { Vedeu::CLI::View }
+      let(:instance)  { described.new(_name) }
+      let(:_name)     { 'my_first_view' }
+
+      describe '#initialize' do
+        it { instance.must_be_instance_of(described) }
+        it { instance.instance_variable_get('@name').must_equal(_name) }
+      end
+
+      describe '.generate' do
+        # before do
+        #   FileUtils.stubs(:cp_r)
+        #   FileUtils.stubs(:mkdir)
+        # end
+
+        subject { described.generate(_name) }
+
+        # @todo
+        # it { skip }
+      end
+
+      describe '#generate' do
+        it { described.must_respond_to(:generate) }
+      end
+
+    end # View
+
+  end # CLI
+
+end # Vedeu

data/test/lib/vedeu_cli_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+describe Vedeu do
+
+  # ...
+  # @todo Add more tests.
+  # it { skip }
+
+end # Vedeu
+
+

data/test/test_helper.rb

@@ -0,0 +1,46 @@
+require 'simplecov'
+require 'simplecov-console' if ENV['CONSOLE_COVERAGE']
+require 'pry'
+require 'minitest/autorun'
+require 'minitest/pride' unless ENV['NO_COLOR']
+require 'minitest/hell'
+
+module VedeuMiniTestPlugin
+  # def before_setup
+  #   super
+  # end
+
+  # def after_setup
+  #   super
+  # end
+
+  # def before_teardown
+  #   super
+  # end
+
+  # def after_teardown
+  #   super
+  # end
+end # VedeuMiniTestPlugin
+
+module MiniTest
+
+  class Spec
+
+    # parallelize_me! # uncomment to unleash hell
+    # i_suck_and_my_tests_are_order_dependent! # just incase
+
+    include VedeuMiniTestPlugin
+
+    class << self
+
+      alias_method :context, :describe
+
+    end # Eigenclass
+
+  end # Spec
+
+end # MiniTest
+
+require 'mocha/setup'
+require 'vedeu_cli'

data/vedeu_cli.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vedeu/cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'vedeu_cli'
+  spec.version       = Vedeu::CLI::VERSION
+  spec.authors       = ['Gavin Laking']
+  spec.email         = ['gavinlaking@gmail.com']
+
+  spec.summary       = 'A plugin for Vedeu.'
+  spec.description   = 'Provides client application generators for Vedeu.'
+  spec.homepage      = 'http://github.com/gavinlaking/vedeu_cli'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'guard',              '2.13.0'
+  spec.add_development_dependency 'guard-minitest',     '2.4.4'
+  spec.add_development_dependency 'minitest',           '5.8.0'
+  spec.add_development_dependency 'minitest-reporters', '1.0.19'
+  spec.add_development_dependency 'mocha',              '1.1.0'
+  spec.add_development_dependency 'pry',                '0.10.1'
+  spec.add_development_dependency 'rake',               '~> 10.0'
+  spec.add_development_dependency 'rubocop',            '0.33.0'
+  spec.add_development_dependency 'ruby-prof',          '0.15.8'
+  spec.add_development_dependency 'simplecov',          '0.10.0'
+  spec.add_development_dependency 'simplecov-console',  '0.2.0'
+  spec.add_development_dependency 'yard',               '0.8.7.6'
+
+  spec.add_dependency 'thor', '0.19.1'
+  spec.add_dependency 'vedeu'
+end