charmkit 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c878e1c9969cd28bfe668eec949485e42a82e45
-  data.tar.gz: 191e80b46dfdb070b102b96676af194251389dcf
+  metadata.gz: 3519af554753017d8e7c77959346ac4f940c8428
+  data.tar.gz: e341f3c8fe1a68e968fc413abb1f0f349ef6fa38
 SHA512:
-  metadata.gz: 07a8742a86c0e9965789bfbf9538e4243d560d176c43ba9f046164438a40e53d6819e75085460641bd2e7a0410333a33d684347a1ee0e8610d8d8584b77d9491
-  data.tar.gz: 1f8388bda4197f7d62ceb69b31a9e53f85d893aaf0b1e1f65982dc204bd41498fcb200a3285bb81fc9c11e6e3950318cf1317cb5190692adb05a3863d11511ac
+  metadata.gz: 1b42e25af103f7f53002fd5027ee149a93f7741f5d84996def178085f4a3e82b1286d8a441429d49bfc2b167c7b92b59e06306ac2f2f4fcc8de7ba4ebc21914f
+  data.tar.gz: a2a68033f643ac43a05b425cbf3dcdf69125b127bf9bbf78ee81500e0af14d1c79825531e9709b4124509240d2d37ccfa59cb7df010cae14599c28e5180deee6

data/README.md

@@ -25,21 +25,20 @@ In **hooks/install**:
 #!/bin/sh
 
 apt-get update
-apt-get install -qyf ruby --no-install-recommends
+apt-get install -qyf ruby bundler --no-install-recommends
 gem install bundler
 
-bundle install --local --quiet
+bundle install --local --quiet --without development
 
-# Runs the lib/install.rb hook
-bundle exec charmkit hook install
+bundle exec rake dokuwiki:install
 ```
 
-In other hooks call *charmkit* with the execing hook (eg. **hooks/config-changed**)
+In other hooks call relevant rake tasks (eg. **hooks/config-changed**)
 
 ```
 #!/bin/sh
 
-bundle exec charmkit hook config-changed
+bundle exec rake dokuwiki:config_changed
 ```
 
 Same for **hooks/upgrade-charm**
@@ -47,78 +46,96 @@ Same for **hooks/upgrade-charm**
 ```
 #!/bin/sh
 
-bundle exec charmkit hook upgrade-charm
+bundle exec rake dokuwiki:upgrace_charm
 ```
 
 ## Writing Charmkit style hooks
 
-All Charmkit hooks must reside in the charm's toplevel **lib/** directory. Those
-files must match the name of the hook you want to assicate to and must end with
-a **.rb** extension.
-
-For example, if my hook runs `bundle exec charmkit hook config-changed` then in my
-**lib/** directory should exist a file named **lib/config-changed.rb**.
-
-To start, you'll want to inherit from the **Charmkit** class. The class name should also
-reflect the name of the hook being executed and should be in a standard Ruby camelcase style.
-
-See the syntax below for a the **config-changed** hook being run:
+All Charmkit hooks will reside in a normal **Rakefile**.
 
 ### Syntax
 
 ```ruby
-class ConfigChanged < Charmkit::Hook
-  use :nginx
+require 'charmkit'
 
-  summon do
-    package [
-        'php-fpm',      'php-cgi',      'php-curl', 'php-gd', 'php-json',
-        'php-mcrypt', 'php-readline', 'php-mbstring', 'php-xml'
-    ], :update_cache
+namespace :dokuwiki do
 
+  desc "Install Dokuwiki"
+  task :install do
+    use :nginx
+    use :php
+
+    deps.install
+
+    app_path = config 'app_path'
+    resource_path = resource 'stable-release'
     hook_path = ENV['JUJU_CHARM_DIR']
-    app_path = path(config('app_path'))
 
-    mkdir app_path
+    mkdir_p app_path
+
+    run "tar", "xf", resource_path, "-C", app_path, "--strip-components=1"
 
-    resource_path = path(resource('stable-release'))
-    run "tar xf #{resource_path} -C #{app_path} --strip-components=1"
+    cp "#{hook_path}/templates/acl.auth.php", "#{app_path}/conf/acl.auth.php"
+    cp "#{hook_path}/templates/local.php", "#{app_path}/conf/local.php"
+    cp "#{hook_path}/templates/plugins.local.php", "#{app_path}/conf/plugin.local.php"
 
-    rm app_path/"conf/install.php"
-    status :active, "Dokuwiki configuration updated."
+    version = File.read "#{app_path}/VERSION"
+    run "application-version-set", version.chomp
+    status :active, "Dokuwiki installed, please set your admin user and password with juju config dokuwiki admin_user=<an_admin_name> admin_password=<sha512 password>"
   end
 
-  test do
-    cmd.test '-e /etc/passwd'
+  desc "Configure Dokuwiki"
+  task :config_changed do
+    app_path = config 'app_path'
+    hook_path = ENV['JUJU_CHARM_DIR']
+
+    admin_user = config 'admin_user'
+    admin_password = config 'admin_password'
+    admin_name = config 'admin_name'
+    admin_email = config 'admin_email'
+    template "#{hook_path}/templates/users.auth.php",
+             "#{app_path}/conf/users.auth.php",
+             admin_user: admin_user,
+             admin_password: admin_password,
+             admin_name: admin_name,
+             admin_email: admin_email
+
+    public_address = unit 'public-address'
+    template "#{hook_path}/templates/vhost.conf",
+             "/etc/nginx/sites-enabled/default",
+             public_address: public_address,
+             app_path: app_path
+
+    chown_R 'www-data', 'www-data', app_path
+
+    run "systemctl restart php7.0-fpm"
+    run "systemctl restart nginx"
+    run "open-port 80"
+    status :active, "Dokuwiki updated and is now ready."
   end
 end
+
+task :default => 'dokuwiki:install'
 ```
 
-The core of Charmkit is relatively small and everything is handled through
-scrolls (read
-plugins). [Visit Charmkit Scrolls](https://github.com/charmkit/charmkit-scrolls)
-for more information.
+The core of Charmkit contains a few helpers such as template rendering but otherwise kept relatively small.
 
 
 ## Packaging the Charm
 
 ```
-$ bundle exec charmkit build
+$ bundle package
 ```
 
 This will package and cache all required gems, along with making sure the necessary
-scrolls are included. The output will be a charm that you can deploy via:
-
-```
-$ juju deploy dist/.
-```
+scrolls are included.
 
 ## Uploading to charm store
 
 Once the charm is built simply run:
 
 ```
-$ charm push dist/.
+$ charm push .
 ```
 
 ## Development

data/charmkit.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "charmkit"
-  spec.version       = "1.0.1"
+  spec.version       = "1.0.2"
   spec.authors       = ["Adam Stokes"]
   spec.email         = ["battlemidget@users.noreply.github.com"]
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: charmkit
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Adam Stokes
@@ -208,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Helps with charm authoring