arethusa-cli 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 217c5ae86d522ea8ac29f3156d9b550ad1fa375e
+  data.tar.gz: 123fc0bca8f6823a192555b76e98126ab7dded3b
+SHA512:
+  metadata.gz: ebd2477b7d10ea17a75601ae85973d74eceb025825c889f536d7fcd6a8adf122215198ef682938f5c327b61240418395e60208fbf4cfb8a07f9f20525b35ab5d
+  data.tar.gz: 079dd82eb262800464a8c28e927fe6bd7af0252582c51051e12cb19f7b1cf57ca1e65341ac67c2c5908fd756e483376709ba5d46b821d2efeec94540478337dd

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,8 @@
+---
+language: ruby
+before_script:
+- export JRUBY_OPTS=--2.0
+rvm:
+- 2.1.0
+- 2.0.0
+- jruby-1.7.8

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in arethusa_plugin_generator.gemspec
+gemspec
+gem 'coveralls', require: false

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 LFDM
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# Arethusa::CLI
+
+[![Version](http://allthebadges.io/latin-language-toolkit/arethusa_plugin_generator/badge_fury.png)](http://allthebadges.io/latin-language-toolkit/arethusa_plugin_generator/badge_fury)
+[![Dependencies](http://allthebadges.io/latin-language-toolkit/arethusa_plugin_generator/gemnasium.png)](http://allthebadges.io/latin-language-toolkit/arethusa_plugin_generator/gemnasium)
+[![Build Status](http://allthebadges.io/latin-language-toolkit/arethusa_plugin_generator/travis.png)](http://allthebadges.io/latin-language-toolkit/arethusa_plugin_generator/travis)
+[![Coverage](http://allthebadges.io/latin-language-toolkit/arethusa_plugin_generator/coveralls.png)](http://allthebadges.io/latin-language-toolkit/arethusa_plugin_generator/coveralls)
+[![Code Climate](http://allthebadges.io/latin-language-toolkit/arethusa_plugin_generator/code_climate.png)](http://allthebadges.io/latin-language-toolkit/arethusa_plugin_generator/code_climate)
+
+Command line tools for [Arethusa](http://github.com/latin-language-toolkit/arethusa)
+
+## Installation
+
+```
+  gem install arethusa-cli
+```
+
+## Usage
+
+- Plugin generator
+
+If you want to create a new plugin, go to you Arethusa directory and
+then run
+
+```
+  arethusa generate plugin NAME
+```
+
+This will create all files and make all changes you need to get started with your plugin. Also check out `arethusa generate help plugin` to learn about additional options.
+
+
+- Deployment and build helpers
+
+If you plan to deploy Arethusa on a webserver like Apache, the `arethusa build`
+command will help you bundle up all needed files and `arethusa deploy`
+will make it easy to deploy Arethusa on a remote server.
+
+Use the usage descriptions (`arethusa help build` and `arethusa help
+deploy`) for more detailed instructions.
+
+
+## Disclaimer
+
+Make sure you're running the latest version of this gem at all times. It
+might change frequently, as Arethusa is continuing to make progress.
+
+All commands have to be called from within your Arethusa directory.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/arethusa-cli/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/arethusa-cli.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'arethusa/cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "arethusa-cli"
+  spec.version       = Arethusa::CLI::VERSION
+  spec.authors       = ["LFDM"]
+  spec.email         = ["1986gh@gmail.com"]
+  spec.summary       = %q{Command line tools for Arethusa}
+  spec.description   = spec.summary
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov", "~> 0.7"
+  spec.add_dependency "thor"
+end

data/bin/arethusa

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'arethusa'
+Arethusa::CLI.start

data/lib/arethusa/cli/generator.rb

@@ -0,0 +1,151 @@
+require 'thor'
+
+class Arethusa::CLI
+  class Generator < Subcommand
+    as_subcommand :generate
+
+    def self.source_root
+      File.dirname(__FILE__)
+    end
+
+    include Thor::Actions
+    attr_reader :namespace, :name
+
+    desc 'plugin NAME', 'Creates a new Arethusa plugin skeleton'
+    method_option :namespace, aliases: '-n', default: 'arethusa',
+      desc: 'Namespace of the new plugin'
+    method_option :commit, type: :boolean, aliases: '-c',
+      desc: 'Commit the skeleton with git'
+    def plugin(name)
+      @name = name
+      @namespace = options[:namespace]
+
+      create_directories
+      create_files
+
+      try('insert module into arethusa', :add_module)
+      try('add minification routine', :add_minification)
+      try('add minification task', :add_minification_task)
+      try('add module to index.html', :add_to_index)
+
+      commit_changes if options[:commit]
+
+      puts
+      say_status(:success, "Created #{namespaced_name}")
+      give_conf_instructions
+    end
+
+    no_commands do
+      def try(message, method)
+        puts
+        say_status('trying', "to #{message}...", :yellow)
+        send(method)
+      end
+
+      def namespaced_name
+        [namespace, name].compact.join('.')
+      end
+
+      DIRECTORIES = %w{ plugin_dir template_dir }
+      def create_directories
+        DIRECTORIES.each { |dir| empty_directory(send(dir)) }
+      end
+
+      def create_files
+        create_module
+        create_service
+        create_html_template
+      end
+
+      def create_module
+        template('templates/module.tt', js_dir("#{namespaced_name}.js"))
+      end
+
+      def create_service
+        template('templates/service.tt', plugin_dir("#{name}.js"))
+      end
+
+      def create_html_template
+        template('templates/html_template.tt', html_template_file)
+      end
+
+      def add_module
+        insert_into_file(arethusa_main, before: /\n\]/, force: false) do
+          ",\n  '#{namespaced_name}'"
+        end
+      end
+
+      def arethusa_main
+        js_dir('arethusa.js')
+      end
+
+      def add_minification
+        insert_into_file(gruntfile, after: /pluginFiles\(.*?core.*?\).*?\n/, force: false) do
+          %[      #{name}: { files: pluginFiles('#{namespaced_name}') },\n]
+        end
+      end
+
+      def add_minification_task
+        insert_into_file(gruntfile, after: /registerTask.*?minify.*?\n/, force: false) do
+          %{    'uglify:#{name}',\n}
+        end
+      end
+
+      def gruntfile
+        File.join(destination_root, 'Gruntfile.js')
+      end
+
+      def add_to_index
+        insert_into_file(index_file, after: /script.*?core.*?script>\n/) do
+          %{  <script src="../dist/#{namespaced_name}.min.js"></script>\n}
+        end
+      end
+
+      def index_file
+        File.join(destination_root, 'app', 'index.html')
+      end
+
+      def give_conf_instructions
+        text = <<-EOF
+Now add your new #{name} plugin to a conf file and add a configuration for it.
+It could look like this:
+
+ "#{name}" : {
+   "name" : "#{name}",
+   "template" : "#{html_template_file.slice(/template.*/)}"
+ }
+        EOF
+        puts text.lines.map { |line| "\t#{line}" }.join
+      end
+
+      def plugin_dir(file = '')
+        File.join(js_dir, namespaced_name, file)
+      end
+
+      def template_dir(file = '')
+        File.join(temp_dir, namespaced_name, file)
+      end
+
+      def html_template_file
+        template_dir("#{name}.html")
+      end
+
+      def js_dir(file = '')
+        File.join(destination_root, 'app/js', file)
+      end
+
+      def temp_dir
+        File.join(destination_root, 'app/templates')
+      end
+
+      def commit_changes
+        message = %{"Add skeleton for #{namespaced_name}"}
+        `git add -A`
+        `git commit -m #{message}`
+        sha = `git rev-parse --short HEAD`.chomp
+        puts
+        say_status(:commited, %(#{sha} #{message}))
+      end
+    end
+  end
+end

data/lib/arethusa/cli/subcommand.rb

@@ -0,0 +1,11 @@
+class Arethusa::CLI
+  class Subcommand < Thor
+    def self.as_subcommand(subcommand)
+      namespace(subcommand)
+
+      def self.banner(command, namespace = nil, subcommand = false)
+        "#{basename} #{@namespace} #{command.usage}"
+      end
+    end
+  end
+end

data/lib/arethusa/cli/templates/html_template.tt

@@ -0,0 +1 @@
+This is the HTML template for <%= namespaced_name %>

data/lib/arethusa/cli/templates/module.tt

@@ -0,0 +1,2 @@
+"use strict";
+angular.module('<%= namespaced_name %>', ['arethusa.core']);

data/lib/arethusa/cli/templates/service.tt

@@ -0,0 +1,19 @@
+"use strict";
+
+angular.module('<%= namespaced_name %>').service('<%= name %>', [
+  'state',
+  'configurator',
+  function(state, configurator) {
+    var self = this;
+
+    function configure() {
+      configurator.getConfAndDelegate('<%= name %>', self);
+    }
+
+    configure();
+
+    this.init = function() {
+      configure();
+    };
+  }
+]);

data/lib/arethusa/cli/version.rb

@@ -0,0 +1,5 @@
+module Arethusa
+  class CLI
+    VERSION = "0.0.1"
+  end
+end

data/lib/arethusa/cli.rb

@@ -0,0 +1,121 @@
+require 'thor'
+
+module Arethusa
+  class CLI < Thor
+    require 'arethusa/cli/version'
+    require 'arethusa/cli/subcommand'
+
+    require 'arethusa/cli/generator'
+
+    include Thor::Actions
+
+    register(Generator, Generator.namespace, "#{Generator.namespace} [ACTION]", 'Generates Arethusa files. Call "arethusa generate" to learn more')
+
+    desc 'build', 'Creates a tar archive to be used for deployment'
+    method_option :minify, aliases: '-m', type: :boolean, default: true,
+      desc: 'Minifies Arethusa before building'
+    def build
+      minify if options[:minify]
+      empty_directory('deployment')
+      @filename = "#{tar_name}#{ending}"
+      create_tgz
+      say_status(:built, archive_path)
+    end
+
+    desc 'deploy ADDRESS DIRECTORY', 'Deploys an Arethusa archive through ssh'
+    long_desc <<-EOF
+Uses ssh to deploy Arethus on a remote server.
+
+By default a new Arethusa archive file will get created in the process
+(overridden by -f), which will be transferred through ssh to its remote
+location, where the files are decompressed.
+
+A regular ssh connection is used. If you need to specify additional options
+to the ssh command  (like using a specific identity file), use -o and
+pass them as a string. Here's a rather complex usage example:
+
+arethusa deploy user@hostname /var/www -f arethusa-1.0.0.tgz -o "-i key.pem"
+EOF
+    method_option :options, aliases: '-o',
+      desc: 'Options to pass to the ssh command'
+    method_option :file, aliases: '-f',
+      desc: 'Archive file to use - builds a new one by default'
+    method_option :minify, aliases: '-m', type: :boolean, default: true,
+      desc: 'Minifies Arethusa before building'
+    def deploy(address, directory)
+      @address = address
+      @directory = directory
+      @ssh_options = options[:options]
+      @archive = options[:file]
+
+      minify if options[:minify] &! @archive
+      execute
+      say_status(:deployed, "at #{@address} - #{@directory}")
+    end
+
+    no_commands do
+      def minify
+        `grunt minify`
+        say_status(:success, 'minified Arethusa')
+      end
+
+      # For deploy command
+      def execute
+        `#{archive_to_use} | #{ssh} #{decompress}`
+      end
+
+      def compress
+        "tar -zc #{folders_to_deploy.join(' ')}"
+      end
+
+      def archive_to_use
+        @archive ? "cat #{@archive}" : compress
+      end
+
+      def ssh
+        "ssh #{@ssh_options} #{@address}"
+      end
+
+      def decompress
+        "tar -zxC #{@directory}"
+      end
+
+      # For build command
+      def create_tgz
+        `tar -zcf #{archive_path} #{folders_to_deploy.join(' ')}`
+      end
+
+      def folders_to_deploy
+        %w{ app bower_components dist vendor }
+      end
+
+      def archive_path
+        "deployment/#{@filename}"
+      end
+
+      def tar_name
+        [tar_namespace, timestamp, git_branch, commit_sha].join('-')
+      end
+
+      def ending
+        '.tgz'
+      end
+
+      def tar_namespace
+        'arethusa'
+      end
+
+      def git_branch
+        `git rev-parse --abbrev-ref HEAD`.strip
+      end
+
+      def timestamp
+        Time.now.to_i
+      end
+
+      def commit_sha
+        `git rev-parse --short HEAD`.strip
+      end
+    end
+  end
+end

data/lib/arethusa.rb

@@ -0,0 +1,3 @@
+module Arethusa
+  require 'arethusa/cli'
+end

data/spec/lib/arethusa_cli_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Arethusa::CLI do
+  it 'has a version number' do
+    expect(Arethusa::CLI::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'simplecov'
+require 'coveralls'
+
+Coveralls.wear!
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'arethusa'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: arethusa-cli
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- LFDM
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Command line tools for Arethusa
+email:
+- 1986gh@gmail.com
+executables:
+- arethusa
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- arethusa-cli.gemspec
+- bin/arethusa
+- lib/arethusa.rb
+- lib/arethusa/cli.rb
+- lib/arethusa/cli/generator.rb
+- lib/arethusa/cli/subcommand.rb
+- lib/arethusa/cli/templates/html_template.tt
+- lib/arethusa/cli/templates/module.tt
+- lib/arethusa/cli/templates/service.tt
+- lib/arethusa/cli/version.rb
+- spec/lib/arethusa_cli_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Command line tools for Arethusa
+test_files:
+- spec/lib/arethusa_cli_spec.rb
+- spec/spec_helper.rb