know_more 0.9.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ee4ecf0f90a56fc5b2fc704d5c83c9131cd4b8f
+  data.tar.gz: 61a96f9affcbd9871f76b5f0091013948326d27d
+SHA512:
+  metadata.gz: 8f1f38c587b068cb74c95d984f4e13fdb90fbb775249ee3062f67be2cd29628befecd4dc4ec11168353cebb2c1728d3eb7f14ba7d2c62384ba2e323ee8b351e8
+  data.tar.gz: 597048168233919337459e88dd12bf9b2845771149695bc341dc6d9cbcc665d170fee9dc34a29e2d45f1033419c2b5cc156c23f07c5bf3bd86f99fe5ffefa698

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 julien
+
+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,130 @@
+# KnowMore
+
+This gem aims to provide a general questionnaire scaffold, with which you can quickly make you own questionnaire page.
+
+## Installation
+
+This is a Rails-based gem. It can only work with you Rails application.
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'know_more'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+```bash
+$ gem install know_more
+```
+
+## Usage
+How to use KnowMore to generate questionnaire scaffold to you?
+
+```sh
+rails g know_more:init
+```
+
+This will generate a initializer file, where you can config the questionnaire steps and the url to go when questionnaire is finished
+
+Configure the the initializer file `config/initializers/know\_more.rb`
+
+Then run the install generator, which will give you templates, controller concerns, model and migration file.
+
+```sh
+rails g know_more:install MODEL
+```
+This will generate template with erb engine, you can use `--haml` to generate haml template
+
+The argument MODEL indicates the questionnaire model name
+
+It will also create a migration, you can add other attribute to this migration
+
+### What the generated files used for
+1. `app/controllers/concerns/know_more/questionnaire_controller_concerns.rb`
+
+    This file is included by the QuestionnaireController(in the gem), you can add the behaviour
+    that you want to do in each step
+
+    Here is an example:
+    ```rb
+
+    module KnowMore
+      # this module is used to define the functions
+      # that will actually run in the KnowMore/QuestionnaireController
+      module QuestionnaireControllerConcerns
+        def self.included(base)
+          # define the behaviour when included
+          base.before_action :set_questionnaire
+        end
+
+        # _stepN function will be called by questionnaire#stepN
+
+        def _step1
+        end
+
+        def _step1_update
+          @questionnaire.update(questionnaire_params)
+        end
+
+        def _step2
+        end
+
+        def _step2_update
+          @questionnaire.update(questionnaire_params)
+        end
+
+        private
+        def set_questionnaire
+          @questionnaire = current_questionnaire
+        end
+
+        def questionnaire_params
+          params.require(:questionnaire).permit(:attribute1, :attribute2, :attribute3)
+        end
+      end
+    end
+    ```
+2. `app/models/MODEL.rb`
+    This is the questionnaire model, it has an attribute progress which records which step the client was on.
+    Cooperating with `require_questionnaire!`, you can force your client to continue with the previous questionnaire.
+
+Then include the module KnowMore::ControllerHelpers into your ApplicationController or BaseController
+and implement your own `current_questionnaire`
+
+```rb
+class ApplicationController < ActionController::Base
+  include KnowMore::ControllerHelpers
+
+  def current_questionnaire
+    # your implementation
+  end
+end
+```
+
+### Notice
+
+1. The questionnaire returned by current\_questionnaire should be created at first.
+Because the process of doing questionnaire is only editing
+
+2. In the `KnowMore::ControllerHelpers`, it provide a helper function `require_questionnaire!`, it could force user to finish questionnaire before going to a controller
+ by redirecting the user to the last step of the questionnaire
+```rb
+before_action :require_questionnaire!
+```
+
+## Todo
+
+1. add welcome page configuration
+2. allow copy the controller to user app so that user can modify the questionnaire controller
+4. support rename step
+
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,26 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'KnowMore'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/test_app/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+

data/app/assets/config/know_more_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/know_more .js
+//= link_directory ../stylesheets/know_more .css

data/app/assets/javascripts/know_more/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/know_more/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/know_more/application_controller.rb

@@ -0,0 +1,5 @@
+module KnowMore
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/know_more/controller_helpers.rb

@@ -0,0 +1,14 @@
+module KnowMore
+  module ControllerHelpers
+    def current_questionnaire
+      raise 'You must implement current_questionnaire in your controller'
+    end
+
+    def require_questionnaire!
+      return if current_questionnaire.nil?
+      unless current_questionnaire.done?
+        redirect_to know_more.send("questionnaire_#{current_questionnaire.progress}_url"), status: :see_other
+      end
+    end
+  end
+end

data/app/controllers/know_more/questionnaire_controller.rb

@@ -0,0 +1,55 @@
+require "#{Rails.root}/app/controllers/concerns/know_more/questionnaire_controller_concerns.rb"
+
+module KnowMore
+  class QuestionnaireController < ::ApplicationController
+    include QuestionnaireControllerConcerns
+
+    KnowMore.config.pages.times do |n|
+      step_index = n + 1
+
+      # define the new methods
+      define_method "step#{step_index}" do
+        set_current_status(step_index) if current_questionnaire.progress != "step#{step_index}"
+        self.send("_step#{step_index}")
+        render "know_more/questionnaire/step#{step_index}"
+      end
+
+      # define the update methods
+      define_method "step#{step_index}_update" do
+        self.send("_step#{step_index}_update")
+
+        if params[:direction] == 'previous'
+          i = step_index - 1
+          redirect_to self.send("questionnaire_step#{i}_url"), status: :see_other if i > 0
+        else # default is go to the next page
+          i = step_index + 1
+          # for the last step, set questionnaire progress to be done
+          # and go the config.redirect_url
+          if step_index == KnowMore.config.pages
+            current_questionnaire.done!
+            redirect_to KnowMore.config.redirect_url
+          else
+            redirect_to self.send("questionnaire_step#{i}_url"), status: :see_other if i <= KnowMore.config.pages
+          end
+        end
+      end
+    end
+
+    def set_current_status(n)
+      current_questionnaire.send("step#{n}!") unless current_questionnaire.done?
+    end
+    def set_next_status
+      unless current_questionnaire.done?
+        current_questionnaire.progress = ::Questionnaire.progresses[current_questionnaire.progress] + 1
+        current_questionnaire.save
+      end
+    end
+
+    def set_previous_status
+      if ::Questionnaire.progresses[current_questionnaire.progress] > 0
+        current_questionnaire.progress = ::Questionnaire.progresses[current_questionnaire.progress] -1
+        current_questionnaire.save
+      end
+    end
+  end
+end

data/app/helpers/know_more/application_helper.rb

@@ -0,0 +1,4 @@
+module KnowMore
+  module ApplicationHelper
+  end
+end

data/app/jobs/know_more/application_job.rb

@@ -0,0 +1,4 @@
+module KnowMore
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/know_more/application_mailer.rb

@@ -0,0 +1,6 @@
+module KnowMore
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/concerns/know_more/application_record.rb

@@ -0,0 +1,5 @@
+module KnowMore
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/concerns/know_more/questionnaire.rb

@@ -0,0 +1,7 @@
+module KnowMore
+  module Questionnaire
+    def self.included(base)
+      base.enum progress: (1..KnowMore.config.pages).map{|n| "step#{n}".to_sym}.append(:done)
+    end
+  end
+end

data/app/views/layouts/know_more/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Know more</title>
+  <%= stylesheet_link_tag    "know_more/application", media: "all" %>
+  <%= javascript_include_tag "know_more/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,7 @@
+KnowMore::Engine.routes.draw do
+  KnowMore.config.pages.times do |n|
+
+    get "/questionnaire/step#{n+1}", to: "questionnaire#step#{n+1}", as: "questionnaire_step#{n+1}"
+    patch "/questionnaire/step#{n+1}", to: "questionnaire#step#{n+1}_update", as: "questionnaire_step#{n+1}_update"
+  end
+end

data/lib/generators/know_more/init_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators/base'
+
+module KnowMore
+  class InitGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    desc 'Generate initializer'
+
+    def copy_initializer
+      template 'initializer.rb.erb', 'config/initializers/know_more.rb'
+    end
+  end
+end
+

data/lib/generators/know_more/install_generator.rb

@@ -0,0 +1,45 @@
+require 'rails/generators/base'
+
+module KnowMore
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    class_option :haml, :desc => 'Generate Haml pages instead of erb', :type => :boolean
+    # class_option :slim, :desc => 'Generate Slim pages instead of erb', :type => :boolean
+
+    argument :model_name
+
+    desc 'Create views, migration and model for Rails application'
+
+    def before_all
+      @model_name = model_name.underscore
+    end
+
+    def copy_views
+      KnowMore.config.pages.times do |n|
+        @n = n+1
+        copy_template
+      end
+    end
+
+    def copy_concerns
+      template 'concerns.rb.erb', 'app/controllers/concerns/know_more/questionnaire_controller_concerns.rb'
+    end
+
+    def generate_model
+      template 'models/model.rb.erb', "app/models/#{@model_name}.rb"
+    end
+
+    def generate_migration
+      template 'models/migration.rb.erb', "db/migrate/#{Time.now.utc.strftime("%Y%m%d%H%M%S")}_create_#{model_name}.rb"
+    end
+
+    private
+    def copy_template
+      template_engine = 'erb'
+      if options.haml?
+        template_engine = 'haml'
+      end
+      template "#{template_engine}/page_template.erb", "app/views/know_more/questionnaire/step#{@n}.html.#{template_engine}"
+    end
+  end
+end

data/lib/generators/know_more/templates/concerns.rb.erb

@@ -0,0 +1,23 @@
+module KnowMore
+  # this module is used to define the functions
+  # that will actually run in the KnowMore/QuestionnaireController
+  module QuestionnaireControllerConcerns
+    def self.included(base)
+      # define the behaviour when included
+      base.before_action :set_questionnaire
+    end
+
+    # _stepN function will be called by questionnaire#stepN
+  <% KnowMore.config.pages.times do |n| %>
+    def _step<%= n+1 %>
+    end
+
+    def _step<%= n+1 %>_update
+    end
+  <% end %>
+    private
+    def set_questionnaire
+      @questionnaire = current_questionnaire
+    end
+  end
+end