charmkit 0.5.1 → 1.0.0

data/examples/demo/hooks/leader-elected

@@ -0,0 +1,3 @@
+#!/bin/sh
+bundle exec rake leader_elected
+

data/examples/demo/hooks/leader-settings-changed

@@ -0,0 +1,3 @@
+#!/bin/sh
+bundle exec rake leader_settings_changed
+

data/examples/demo/hooks/start

@@ -0,0 +1,3 @@
+#!/bin/sh
+bundle exec rake start
+

data/examples/demo/hooks/stop

@@ -0,0 +1,3 @@
+#!/bin/sh
+bundle exec rake stop
+

data/examples/demo/hooks/update-status

@@ -0,0 +1,3 @@
+#!/bin/sh
+bundle exec rake update_status
+

data/examples/demo/hooks/upgrade-charm

@@ -0,0 +1,3 @@
+#!/bin/sh
+bundle exec rake upgrade_charm
+

data/examples/demo/metadata.yaml

@@ -0,0 +1,9 @@
+name: demo
+summary: |
+  <<insert summary>>
+description: |
+  <<insert description>>
+maintainers: ['']
+series:
+  - xenial
+

data/examples/load-charmkit-file.rb

@@ -0,0 +1,2 @@
+require 'charmkit/scroll'
+load './Charmkitfile

data/examples/plugin_loader.rb

@@ -0,0 +1,9 @@
+require 'charmkit'
+
+class Install < Charmkit
+  plugin :core
+
+  def summon
+    puts run 'ls -l /tmp'
+  end
+end

data/examples/template.rb

@@ -0,0 +1,6 @@
+require 'charmkit'
+
+template 'templates/user_auth.txt', '/tmp/user_auth.txt',
+         firstname: "joe", lastname: "bob"
+
+file "/tmp/another-test.txt", "owned"

data/examples/templates/user_auth.txt

@@ -0,0 +1 @@
+Hi there <%= firstname %> <%= lastname %>

data/exe/charmkit

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'charmkit'
+
+Charmkit::CLI.start

data/lib/charmkit.rb

@@ -1,9 +1,8 @@
-require "charmkit/version"
-require "charmkit/helpers/template"
-require "charmkit/helpers/runner"
-require "charmkit/helpers/hookenv"
-require "charmkit/helpers/fs"
-require "charmkit/helpers/crypt"
+require 'charmkit/helpers'
+require 'charmkit/hook'
+require 'charmkit/scroll'
+require 'charmkit/dependencies'
+require 'charmkit/cli'
 
 module Charmkit; end
-extend Charmkit::Helpers
+extend Charmkit::Base

data/lib/charmkit/cli.rb

@@ -0,0 +1,124 @@
+require "active_support/core_ext/string/inflections"
+require 'pathname'
+require 'thor'
+require 'charmkit'
+require 'charmkit/helpers'
+require 'charmkit/dependencies'
+
+module Charmkit
+  class CLI < Thor
+    desc "generate NAME", "generate a charm skelton"
+    def generate(name)
+      pn = Pathname(name)
+      if pn.directory?
+        puts "#{name} directory exists, please choose a different charm name."
+        exit 1
+      else
+        pn.mkpath
+        pn.join('hooks').mkpath
+      end
+      Helpers.inline_template 'config.yaml', pn/'config.yaml'
+      Helpers.inline_template 'metadata.yaml', pn/'metadata.yaml', name: name
+      Helpers.inline_template 'README.md', pn/'README.md', name: name
+      Helpers.inline_template 'Gemfile', pn/'Gemfile'
+
+      # Write the install hook
+      hook_path = pn.join('hooks/install')
+      Helpers.inline_template 'install-hook', hook_path
+      hook_path.chmod 0755
+
+      # Write other hooks
+      hooks = ['config-changed',
+               'upgrade-charm',
+               'start',
+               'stop',
+               'leader-elected',
+               'leader-settings-changed',
+               'update-status']
+      hooks.each do |hook|
+        hook_path = pn.join("hooks/#{hook}")
+        Helpers.inline_template 'generic-hook', hook_path, hook: hook.underscore
+        hook_path.chmod 0755
+      end
+
+      Helpers.inline_template 'Rakefile', pn/'Rakefile'
+    end
+    map "g" => "generate"
+  end
+end
+
+
+__END__
+
+@@ Gemfile
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+gem "charmkit"
+gem "rake"
+gem "rspec"
+
+# If you wish to load additional scrolls add those here
+# gem "charmkit-scroll-nginx", :github => "battlemidget/charmkit-scroll-nginx"
+
+@@ Rakefile
+require 'charmkit'
+
+desc "Install hook"
+task :install do
+  use :nginx
+  nginx.add_host server_name: "example.com"
+end
+
+@@ install-hook
+#!/bin/sh
+apt-get update && apt-get install -qyf ruby bundler --no-install-recommends
+bundle install --local --quiet --without development
+# Do install task
+bundle exec rake install
+
+@@ generic-hook
+#!/bin/sh
+bundle exec rake <%= hook %>
+
+@@ config.yaml
+options: {}
+
+@@ metadata.yaml
+name: <%= name %>
+summary: |
+  <<insert summary>>
+description: |
+  <<insert description>>
+maintainers: ['']
+series:
+  - xenial
+
+@@ README.md
+# Overview
+
+My charm Overview
+
+# Usage
+
+    $ juju deploy <%= name %>
+
+# Developers
+
+How developers can contribute
+
+# Maintainers
+
+How QA and others can test your charm
+
+# Author
+
+Your name <mememe@email.com>
+
+# Copyright
+
+2016 Your name
+
+# License
+
+MIT

data/lib/charmkit/dependencies.rb

@@ -0,0 +1,26 @@
+module Charmkit
+  class Dependencies
+    include Enumerable
+
+    @@deps = []
+
+    def self.empty?
+      @@deps.empty?
+    end
+
+    def self.install
+      # TODO: Should be a dependency class with options for
+      # installing groups, recommended packages, and snaps
+      puts "Installing #{@@deps.join(' ')}"
+    end
+
+    def self.<<(o)
+      @@deps << o
+      self
+    end
+
+    def self.to_s
+      @@deps.join(' ')
+    end
+  end
+end

data/lib/charmkit/helpers.rb

@@ -0,0 +1,5 @@
+require 'charmkit/helpers/runner'
+require 'charmkit/helpers/fs'
+require 'charmkit/helpers/template'
+require 'charmkit/helpers/hookenv'
+require 'charmkit/helpers/crypt'

data/lib/charmkit/helpers/crypt.rb

@@ -1,11 +1,13 @@
 module Charmkit
   module Helpers
-    # Generate a password salt
-    #
-    # @param [Integer] min mininum number of characters
-    # @param [Integer] max maximum number of characters
-    def gen_salt(min=0, max=20)
-      (min...max).map { ('a'..'z').to_a[rand(26)] }.join
+    class Crypt
+      # Generate a password salt
+      #
+      # @param [Integer] min mininum number of characters
+      # @param [Integer] max maximum number of characters
+      def self.gen_salt(min=0, max=20)
+        (min...max).map { ('a'..'z').to_a[rand(26)] }.join
+      end
     end
   end
 end

data/lib/charmkit/helpers/fs.rb

@@ -19,21 +19,6 @@ module Charmkit
       File.write(dst, content)
     end
 
-    # Check if file exists
-    #
-    # @param path String
-    # @return Boolean
-    #
-    # @example
-    #    is_file? "/etc/nginx/nginx.conf"
-    def is_file?(path)
-      return File.exists? path
-    end
-
-    def is_dir?(path)
-      return Dir.exists? path
-    end
-
     def cat(src)
       return File.read(src)
     end

data/lib/charmkit/helpers/hookenv.rb

@@ -38,6 +38,16 @@ module Charmkit
       return out.chomp
     end
 
+    def relation(item)
+      out, err = cmd.run "relation-get '#{item}'"
+      return out.chomp
+    end
+
+    def relation=(key, item)
+      out, err = cmd.run "relation-set '#{key}=#{item}'"
+      return out.chomp
+    end
+
     def log(msg)
       cmd.run "juju-log #{msg}"
     end

data/lib/charmkit/helpers/runner.rb

@@ -3,7 +3,7 @@ require 'tty-command'
 module Charmkit
   module Helpers
     extend Forwardable
-    def_delegators :cmd, :run, :run!, :test
+    def_delegators :cmd, :run, :run!
 
     def cmd
       if ENV['DRYRUN']
@@ -12,5 +12,6 @@ module Charmkit
         TTY::Command.new
       end
     end
+
   end
 end

data/lib/charmkit/helpers/template.rb

@@ -76,5 +76,6 @@ module Charmkit
         File.write(dst, rendered)
       end
     end
+    module_function :inline_template
   end
 end

data/lib/charmkit/hook.rb

@@ -0,0 +1,47 @@
+module Charmkit
+  module Base
+    include Helpers
+
+    # Include scrolls to be used within hook execution
+    #
+    # Note: Idea lifted from https://github.com/mckomo/metaxa
+    # @param [Symbol] name symbol of scroll
+    # @param [Hash] options (NotImplemented) Options to be passed to scroll
+    # @example
+    #   use :nginx
+    #   nginx.add_host server: "test.com"
+    def use(name, options = {})
+      require "charmkit/scrolls/#{name.to_s}"
+      name_ref = name
+      if options[:alias]
+        name_ref = options[:alias]
+      end
+
+      var_module = Module.new do
+        attr_accessor name_ref.to_sym
+      end
+      extend var_module
+      set(name_ref, to_const(name.to_s).new)
+    end
+
+    # Access deps class
+    #
+    def deps
+      Dependencies
+    end
+
+    private
+    def get(variable)
+      instance_variable_get("@#{variable}")
+    end
+
+    def set(variable, value)
+      instance_variable_set("@#{variable}", value)
+    end
+
+    def to_const(name)
+      klass = name.classify
+      klass.constantize
+    end
+  end
+end

data/lib/charmkit/scroll.rb

@@ -0,0 +1,15 @@
+module Charmkit
+  class Scroll
+    include Helpers
+
+    class << self
+      # Apt packages that the scroll requires
+      #
+      # @param [String] pkg Name of apt package
+      def depends_on(pkg)
+        Dependencies << pkg
+      end
+
+    end
+  end
+end

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: charmkit
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Adam Stokes
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-21 00:00:00.000000000 Z
+date: 2017-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-command
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -125,12 +139,14 @@ dependencies:
 description: ''
 email:
 - battlemidget@users.noreply.github.com
-executables: []
+executables:
+- charmkit
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -140,35 +156,38 @@ files:
 - bin/console
 - bin/setup
 - charmkit.gemspec
-- examples/my-demo-charm/Gemfile
-- examples/my-demo-charm/Gemfile.lock
-- examples/my-demo-charm/README.md
-- examples/my-demo-charm/Rakefile
-- examples/my-demo-charm/config.yaml
-- examples/my-demo-charm/copyright
-- examples/my-demo-charm/hooks/config-changed
-- examples/my-demo-charm/hooks/install
-- examples/my-demo-charm/hooks/upgrade-charm
-- examples/my-demo-charm/icon.svg
-- examples/my-demo-charm/metadata.yaml
-- examples/my-demo-charm/readme
-- examples/my-demo-charm/tasks/vim.rb
-- examples/my-demo-charm/templates/acl.auth.php
-- examples/my-demo-charm/templates/local.php
-- examples/my-demo-charm/templates/plugins.local.php
-- examples/my-demo-charm/templates/users.auth.php
-- examples/my-demo-charm/templates/vhost.conf
-- examples/render_inline.rb
+- examples/Charmkitfile
+- examples/basic.rb
+- examples/demo/Gemfile
+- examples/demo/Gemfile.lock
+- examples/demo/README.md
+- examples/demo/Rakefile
+- examples/demo/config.yaml
+- examples/demo/hooks/config-changed
+- examples/demo/hooks/install
+- examples/demo/hooks/leader-elected
+- examples/demo/hooks/leader-settings-changed
+- examples/demo/hooks/start
+- examples/demo/hooks/stop
+- examples/demo/hooks/update-status
+- examples/demo/hooks/upgrade-charm
+- examples/demo/metadata.yaml
+- examples/load-charmkit-file.rb
+- examples/plugin_loader.rb
+- examples/template.rb
+- examples/templates/user_auth.txt
+- exe/charmkit
 - lib/charmkit.rb
-- lib/charmkit/extend/string_tools.rb
+- lib/charmkit/cli.rb
+- lib/charmkit/dependencies.rb
+- lib/charmkit/helpers.rb
 - lib/charmkit/helpers/crypt.rb
 - lib/charmkit/helpers/fs.rb
 - lib/charmkit/helpers/hookenv.rb
 - lib/charmkit/helpers/runner.rb
 - lib/charmkit/helpers/template.rb
-- lib/charmkit/plugins/nginx.rb
-- lib/charmkit/plugins/php.rb
-- lib/charmkit/version.rb
+- lib/charmkit/hook.rb
+- lib/charmkit/scroll.rb
 homepage: http://charmkit.org
 licenses:
 - MIT
@@ -189,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Helps with charm authoring