adapt-charyf 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4125fa9f68b59e2bc87aca4c9323dffaf2b2f5e9
-  data.tar.gz: 764b916befc17af71dfa835356d82d7e42f3d61e
+  metadata.gz: 4ea719f91c8054cacde7a84ca5dbb632fe84ae6d
+  data.tar.gz: 2f01c46da1dd23664986235bf58587e5abd84d3f
 SHA512:
-  metadata.gz: 7c2f478798f25aa61fd89a5b1ecc91df724946cedf1fd2a1d70f30eb0c40eefba9d37e2378f51b3eef6dbe8f7f8ea4c869e49c1d3a93181943f1c753aa95540c
-  data.tar.gz: fbb76f671f2880ca58d4958007abef7442d24b349f20de378f7bc4980ac148da13fc1dedfec865038e5bc9eb03eb454b30bca46269cff7545cc31ca962171fd0
+  metadata.gz: 725e8c4ba6ca43625a21e01679ce15eeb39702e38bdaefdfbda6a56d98a644537ee61604f1ce88274c32ff0350e5db6a80b544ff144ca1ca75dcf98b3e8a321d
+  data.tar.gz: acf6207915f0a3b78fff29c51e4fbb44634f7401a344be8b527e1f18358ab61fcb0c31c177a6fc1ad6a971bca3a06ff323b544e22486faf59166de2697a55cda

data/README.md

@@ -4,19 +4,57 @@ Adapt-Charyf is a ruby wrapper around Mycroft's Intent parser library [mycroft/A
 
 # Getting Started
 
+## Installing to existing charyf applicaiton
+
 Add this line to your charyf application's Gemfile:
 
 ```ruby
-gem 'adapt-chartf'
+gem 'adapt-charyf'
 ```
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Then add the adapt to the applocation loads by adding line to ``config/load.rb``
+```ruby
+require 'adapt-charyf'
+```
+
+To generate the intializer run
+```bash
+charyf generate adapt:install
+```
+
+You should be welcomed by the message
+```
+      create  config/initializers/adapt.rb
+      notice  Adapt installed
+		Do not forget to set adapt intent processor in application configuration
+```
+
+You can configure the processor inside ``config/initializers/adapt.rb`` which was generated by the installer
+
+Now enable adapt processor inside your application config (``config/application.rb``) or specific environment config (e.g.: ``config/environments/development.rb``)
+
+```ruby
+config.enabled_intent_processors = [.., :adapt, ..]
+```
+
+## Install with new charyf application
+You can add adapt as intent processor during generation of new application. Just use 
+``--intent-processors=adapt`` as argument with your ``charyf new ...`` command.
+
+After new app is created make sure you crete the initializer by running
+```bash
+charyf generate adapt:install
+```
+
+When installing adapt along charyf new application, ``config/loads.rb`` and configuration inside ``config/application.rb`` will be populated automatically.
+
+You can configure the processor inside ``config/initializers/adapt.rb`` which was generated by the installer
 
-    $ gem install adapt-charyf
+## Dependencies
     
 Make sure the python library is installed
 ```pip install -e git+https://github.com/mycroftai/adapt#egg=adapt-parser``` [or use pip3 if desired]

data/lib/adapt-charyf.rb

@@ -6,12 +6,21 @@ require_relative 'adapt/processor'
 module Adapt
   class Extension < Charyf::Extension
 
+    # Load generators inside this block
     generators do
       require_relative 'adapt/generators/intent/intent_generator'
       require_relative 'adapt/generators/install/install_generator'
     end
 
-    config.generators.skill_hooks :intents, :adapt => true
+    # Add generator hooks
+    #
+    # Skill hook is run when new skill is being generated
+    #
+    config.generators.skill_hooks << 'adapt:intent'
+    #
+    # Installers are automatically run if this gem is present during generation of new application
+    #
+    config.generators.installers << 'adapt:install'
 
     # If unset, I18n locale will be used
     config.locale = nil

data/lib/adapt/generators/install/install_generator.rb

@@ -11,10 +11,11 @@ module Adapt
       end
 
       def finalize
-        return unless behavior == :invoke
+        return if behavior != :invoke || options[:autorun]
 
         say_status 'notice', "Adapt installed" +
-            "\n\t\tDo not forget to set adapt intent processor in application configuration", :green
+            "\n\t\tDo not forget to set adapt intent processor in application configuration" +
+            "\n\t\t\tconfig.enabled_intent_processors = [.., :adapt, ..]", :green
       end
 
     end

data/lib/adapt/version.rb

@@ -1,3 +1,3 @@
 module Adapt
-  VERSION = '0.3.3'
+  VERSION = '0.3.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adapt-charyf
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Richard Ludvigh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-14 00:00:00.000000000 Z
+date: 2018-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: charyf