spout 0.12.0.rc → 0.12.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6b577bc1b70562b8fd31c019ebfaf216fbb903c
-  data.tar.gz: 84a57bcf18809bcbe7241e969247ae45023fc583
+  metadata.gz: 0ee597968159c66c33d492721f38b5ba41a682df
+  data.tar.gz: 50ff21c4c9bf2053b9c094c46284cf7e589c1311
 SHA512:
-  metadata.gz: 4498b53635947fb0810c6e3165b58048cf0855130cb6b3a75e47c24ba075d6509cbe10fe2ddcf7c2df01248a73d74f45e79b0847d4a35629c1f399c5ca4b17b0
-  data.tar.gz: c81170c50d3cf60e70f931a8eb75fa09dee569705ec687e513b09fdf7d67cbb418c8e5e5c7b9373d3e5fd7649b9f2feb92a114540e0987d8a18df767d47f7c0c
+  metadata.gz: aba1faeace9de13a80ef0f5e6ae59cd67be9f9baa15704f9439a7701d42f00d9880692a7d4b2d7d1de7045765b5000e9910695e81611d1aea78663e55f5bedf2
+  data.tar.gz: 6e874dadba90dda413a60fc14e7fac481a5526cbd9bcd6376427cd783dd90656d100466d14dc8f938201adcd58e3a2c1451970cf5ac3aac22b73acef4b30579d

data/CHANGELOG.md

@@ -5,8 +5,11 @@
   - Spout now provides a warning and skips columns in CSVs with blank headers
   - `spout new` command now generates `CHANGELOG.md`, `README.md`, and `VERSION`
     placeholder files
-  - Check for the latest version available using `spout update`
   - Integer and numeric variables can now reference a domain for missing values
+- **Update Command Added**
+  - Check for the latest version available using `spout update`
+  - The update command provides steps to upgrade the data dictionary to the
+    latest version Spout
 - **Exporter Changes**
   - The export command now exports the variable forms attribute
   - Dictionary exports now are in `exports` instead of `dd` folder

data/lib/spout/commands/project_generator.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
 require 'colorize'
-require 'date'
-require 'erb'
 require 'fileutils'
 
-TEMPLATES_DIRECTORY = File.expand_path('../../templates', __FILE__)
+require 'spout/helpers/framework'
 
 module Spout
   module Commands
     # Generates folder and file structure for a new spout data dictionary.
     class ProjectGenerator
+      include Spout::Helpers::Framework
+
       def initialize(argv)
         generate_folder_structure!(argv)
       end
@@ -54,33 +54,6 @@ EOT
         Dir.chdir(@full_path)
         system 'bundle install'
       end
-
-      private
-
-      def copy_file(template_file, file_name = '')
-        file_name = template_file if file_name == ''
-        file_path = File.join(@full_path, file_name)
-        template_file_path = File.join(TEMPLATES_DIRECTORY, template_file)
-        puts '      create'.colorize(:green) + "  #{file_name}"
-        FileUtils.copy(template_file_path, file_path)
-      end
-
-      def evaluate_file(template_file, file_name)
-        template_file_path = File.join(TEMPLATES_DIRECTORY, template_file)
-        template = ERB.new(File.read(template_file_path))
-        file_path = File.join(@full_path, file_name)
-        file_out = File.new(file_path, 'w')
-        file_out.syswrite(template.result(binding))
-        puts '      create'.colorize(:green) + "  #{file_name}"
-      ensure
-        file_out.close if file_out
-      end
-
-      def directory(directory_name)
-        directory_path = File.join(@full_path, directory_name)
-        puts '      create'.colorize(:green) + "  #{directory_name}"
-        FileUtils.mkpath(directory_path)
-      end
     end
   end
 end

data/lib/spout/commands/update.rb

@@ -2,11 +2,14 @@
 
 require 'colorize'
 require 'spout/helpers/json_request'
+require 'spout/helpers/framework'
 
 module Spout
   module Commands
     # Command to check if there is an updated version of the gem available.
     class Update
+      include Spout::Helpers::Framework
+
       class << self
         def start(*args)
           new(*args).start
@@ -14,6 +17,7 @@ module Spout
       end
 
       def initialize(argv)
+        @full_path = File.join('.')
       end
 
       def start
@@ -21,17 +25,88 @@ module Spout
         if json
           if json['version'] == Spout::VERSION::STRING
             puts 'The spout gem is ' + 'up-to-date'.colorize(:green) + '!'
+            check_framework if File.exist?('Gemfile')
           else
-            puts
-            puts "A newer version (v#{json['version']}) is available! Type the following command to update:"
-            puts
-            puts '  gem install spout --no-document'.colorize(:white)
-            puts
+            puts "A newer version (v#{json['version']}) is available!\n\n"
+            if File.exist?('Gemfile')
+              puts 'Add the following to your Gemfile and run ' + 'bundle update'.colorize(:green) + ".\n\n"
+              puts "  gem 'spout', '~> #{json['version']}'\n".colorize(:white)
+            else
+              puts "Type the following command to update:\n\n"
+              puts '  gem install spout --no-document'.colorize(:white) + "\n\n"
+            end
           end
         else
           puts 'Unable to connect to RubyGems.org. Please try again later.'
         end
       end
+
+      def check_framework
+        check_gitignore_file
+        check_ruby_version
+        check_file_presence
+        check_folder_presence
+        check_test_folder
+      end
+
+      def check_gitignore_file
+        if File.exist?('.gitignore')
+          lines = IO.readlines('.gitignore').collect(&:strip)
+          addables = ['/coverage', '/csvs', '/exports', '/graphs']
+          removables = ['/dd', '/images']
+          unless ((removables & lines) | (addables - lines)).empty?
+            puts 'File: ' + '.gitignore'.colorize(:white)
+            puts '----------------'
+            (removables & lines).each do |removable|
+              puts 'REMOVE LINE '.colorize(:red) + removable.colorize(:white)
+            end
+            (addables - lines).each do |addable|
+              puts '   ADD LINE '.colorize(:green) + addable.colorize(:white)
+            end
+            puts
+          end
+        else
+          copy_file 'gitignore', '.gitignore'
+        end
+      end
+
+      def check_ruby_version
+        if File.exist?('.ruby-version')
+          lines = IO.readlines('.ruby-version').collect(&:strip)
+          template_lines = IO.readlines(File.expand_path('../../templates/ruby-version', __FILE__)).collect(&:strip)
+          if template_lines.first != lines.first
+            puts 'File: ' + '.ruby-version'.colorize(:white)
+            puts '-------------------'
+            print 'Update Ruby from ' + lines.first.to_s.colorize(:red)
+            print ' to ' + template_lines.first.to_s.colorize(:green)
+            puts "\n\n"
+          end
+        else
+          copy_file 'ruby-version', '.ruby-version'
+        end
+      end
+
+      def check_file_presence
+        @project_name = File.basename(Dir.pwd)
+        evaluate_file 'CHANGELOG.md.erb', 'CHANGELOG.md' unless File.exist?('CHANGELOG.md')
+        evaluate_file 'README.md.erb', 'README.md' unless File.exist?('README.md')
+        copy_file 'VERSION' unless File.exist?('VERSION')
+      end
+
+      def check_folder_presence
+        folders = %w(domains forms variables).reject { |f| Dir.exist?(f) }
+        folders.each do |folder|
+          directory folder
+          copy_file 'keep', "#{folder}/.keep"
+        end
+      end
+
+      def check_test_folder
+        return if Dir.exist?('test')
+        directory 'test'
+        copy_file 'test/dictionary_test.rb'
+        copy_file 'test/test_helper.rb'
+      end
     end
   end
 end

data/lib/spout/helpers/framework.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'colorize'
+require 'date'
+require 'erb'
+require 'fileutils'
+
+TEMPLATES_DIRECTORY = File.expand_path('../../templates', __FILE__)
+
+module Spout
+  module Helpers
+    # Helpers to generate and update Spout dictionary framework.
+    module Framework
+      def copy_file(template_file, file_name = '')
+        file_name = template_file if file_name == ''
+        file_path = File.join(@full_path, file_name)
+        template_file_path = File.join(TEMPLATES_DIRECTORY, template_file)
+        puts '      create'.colorize(:green) + "  #{file_name}"
+        FileUtils.copy(template_file_path, file_path)
+      end
+
+      def evaluate_file(template_file, file_name)
+        template_file_path = File.join(TEMPLATES_DIRECTORY, template_file)
+        template = ERB.new(File.read(template_file_path))
+        file_path = File.join(@full_path, file_name)
+        file_out = File.new(file_path, 'w')
+        file_out.syswrite(template.result(binding))
+        puts '      create'.colorize(:green) + "  #{file_name}"
+      ensure
+        file_out.close if file_out
+      end
+
+      def directory(directory_name)
+        directory_path = File.join(@full_path, directory_name)
+        puts '      create'.colorize(:green) + "  #{directory_name}"
+        FileUtils.mkpath(directory_path)
+      end
+    end
+  end
+end

data/lib/spout/version.rb

@@ -5,7 +5,7 @@ module Spout
     MAJOR = 0
     MINOR = 12
     TINY = 0
-    BUILD = 'rc' # 'pre', 'rc', 'rc2', nil
+    BUILD = 'rc2' # 'pre', 'rc', 'rc2', nil
 
     STRING = [MAJOR, MINOR, TINY, BUILD].compact.join('.').freeze
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spout
 version: !ruby/object:Gem::Version
-  version: 0.12.0.rc
+  version: 0.12.0.rc2
 platform: ruby
 authors:
 - Remo Mueller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-27 00:00:00.000000000 Z
+date: 2017-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -121,6 +121,7 @@ files:
 - lib/spout/helpers/array_statistics.rb
 - lib/spout/helpers/chart_types.rb
 - lib/spout/helpers/config_reader.rb
+- lib/spout/helpers/framework.rb
 - lib/spout/helpers/iterators.rb
 - lib/spout/helpers/json_loader.rb
 - lib/spout/helpers/json_request.rb