profile_wizard 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 02c81da54cb7e78cc64ae4621ab644b206849462d28cce7c577058b14caccbe8
+  data.tar.gz: e8dc8792dd1a627aaf7ec1615b37dd93d6560de1f7cd62c3827e6008a793468e
+SHA512:
+  metadata.gz: 8062aea215b606039b61d49555de0752f37cca8e405dde25a22cd537710063255a6d26a796142bdcf88e4e12fcf09b4d225500ab67057114d1ecd513c65c92d0
+  data.tar.gz: 8c861e06f7ff19e037bbe9ac29e5877c2c4aae1407321713b37f73b939ec0b55526174b4800eb08ed43bdc915a957e15a383ac2017b1fad0a7f52a7d52bc6216

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 BV Satyaramwq
+
+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,28 @@
+# ProfileWizard
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'profile_wizard'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install profile_wizard
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+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    = 'ProfileWizard'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/profile_wizard_manifest.js

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

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

@@ -0,0 +1,15 @@
+// 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 rails-ujs
+//= require activestorage
+//= require_tree .

data/app/assets/stylesheets/profile_wizard/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/profile_wizard/application_controller.rb

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

data/app/helpers/profile_wizard/application_helper.rb

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

data/app/jobs/profile_wizard/application_job.rb

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

data/app/mailers/profile_wizard/application_mailer.rb

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

data/app/models/profile_wizard/answer.rb

@@ -0,0 +1,5 @@
+module ProfileWizard
+  class Answer < ApplicationRecord
+    belongs_to :record, polymorphic: true, touch: true
+  end
+end

data/app/models/profile_wizard/application_record.rb

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

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

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Profile wizard</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "profile_wizard/application", media: "all" %>
+  <%= javascript_include_tag "profile_wizard/application" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+ProfileWizard::Engine.routes.draw do
+end

data/db/migrate/20190307200449_create_profile_wizard_answers.rb

@@ -0,0 +1,13 @@
+class CreateProfileWizardAnswers < ActiveRecord::Migration[5.2]
+  def change
+    create_table :profile_wizard_answers do |t|
+      t.string :name, null: false
+      t.json :data
+      t.references :record, null: false, polymorphic: true, index: false
+
+      t.timestamps
+
+      t.index [ :record_type, :record_id, :name ], name: "index_profile_wizard_answers_uniqueness", unique: true
+    end
+  end
+end

data/lib/profile_wizard.rb

@@ -0,0 +1,5 @@
+require "profile_wizard/engine"
+
+module ProfileWizard
+  # Your code goes here...
+end

data/lib/profile_wizard/engine.rb

@@ -0,0 +1,11 @@
+require_relative './models'
+
+module ProfileWizard
+  class Engine < ::Rails::Engine
+    isolate_namespace ProfileWizard
+
+    config.to_prepare do
+      ActiveRecord::Base.extend ProfileWizard::Models
+    end
+  end
+end

data/lib/profile_wizard/models.rb

@@ -0,0 +1,13 @@
+require_relative './models/profile'
+require_relative './models/step'
+require_relative './models/question'
+
+module ProfileWizard
+  module Models
+    def profile_wizard(profile_attr, profile_schema, opts = {})
+      define_method(profile_attr) do
+        @profile_attr ||= ProfileWizard::Models::Profile.new profile_attr, profile_schema, self
+      end
+    end
+  end
+end

data/lib/profile_wizard/models/profile.rb

@@ -0,0 +1,47 @@
+module ProfileWizard::Models
+  class Profile
+    attr_accessor :steps
+
+    def initialize(profile_attr, profile_schema, record)
+      @steps = {}
+      @profile_attr = profile_attr
+      @record = record
+      profile_schema.each do |step_key, step_schema|
+        self.class.class_eval do
+          define_method(step_key) do
+            @steps[step_key] ||= ProfileWizard::Models::Step.new(step_key, step_schema)
+          end
+        end
+        send(step_key)
+      end
+    end
+
+    def save
+      answer.data = json_answer_data
+      answer.save if answer.data_changed?
+    end
+
+    def save!
+      answer.data = json_answer_data
+      answer.save! if answer.data_changed?
+    end
+
+    private
+
+    def answer
+      @answer ||= ProfileWizard::Answer.find_or_initialize_by(record: @record, name: @profile_attr)
+    end
+
+    def json_answer_data
+      data = {}
+      steps.each do |step_key, step|
+        data[step_key] = {}
+        step.questions.each do |question_key, question|
+          data[step_key][question_key] = question.answer
+        end
+      end
+
+      data
+    end
+  end
+end

data/lib/profile_wizard/models/question.rb

@@ -0,0 +1,20 @@
+module ProfileWizard::Models
+  class Question
+    attr_accessor :answer
+
+    def initialize(question_key, question_schema, step)
+      @step = step
+      @meta_info = {}
+      @meta_info[:title] = question_schema[:title] || ActiveSupport::Inflector.humanize(question_key).titleize
+      @meta_info[:required] = question_schema[:required].nil? ? step.required? : question_schema[:required]
+    end
+
+    def title
+      @meta_info[:title]
+    end
+
+    def required?
+      @meta_info[:required]
+    end
+  end
+end

data/lib/profile_wizard/models/step.rb

@@ -0,0 +1,36 @@
+module ProfileWizard::Models
+  class Step
+    attr_accessor :questions,
+                  :profile_wizard_step_title,
+                  :profile_wizard_step_required
+
+    def initialize(step_key, step_schema)
+      @questions = {}
+      @meta_info = {}
+      @meta_info[:title] = step_schema[:title] || ActiveSupport::Inflector.humanize(step_key).titleize
+      @meta_info[:required] = step_schema[:required] || false
+      step_ref = self
+      step_schema[:questions].each do |question_key, question_schema|
+        self.class.class_eval do
+          define_method(question_key) do
+            @questions[question_key] ||= ProfileWizard::Models::Question.new(question_key, question_schema, step_ref)
+          end
+
+          define_method("#{question_key}=") do |val|
+            @questions[question_key].answer = val
+          end
+        end
+        send(question_key)
+      end
+    end
+
+    # We are making an assumption that there won't be a question with the key `:title`
+    def title
+      @meta_info[:title]
+    end
+
+    def required?
+      @meta_info[:required]
+    end
+  end
+end

data/lib/profile_wizard/version.rb

@@ -0,0 +1,3 @@
+module ProfileWizard
+  VERSION = '0.1.0'
+end

data/lib/tasks/profile_wizard_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :profile_wizard do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: profile_wizard
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- BV Satyaram
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+description: ProfileWizard is a rails engine that lets you easily plug profile completion
+  wizard into your app, not worrying much about adding required profile fields to
+  your schema.
+email:
+- bvsatyaram@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/profile_wizard_manifest.js
+- app/assets/javascripts/profile_wizard/application.js
+- app/assets/stylesheets/profile_wizard/application.css
+- app/controllers/profile_wizard/application_controller.rb
+- app/helpers/profile_wizard/application_helper.rb
+- app/jobs/profile_wizard/application_job.rb
+- app/mailers/profile_wizard/application_mailer.rb
+- app/models/profile_wizard/answer.rb
+- app/models/profile_wizard/application_record.rb
+- app/views/layouts/profile_wizard/application.html.erb
+- config/routes.rb
+- db/migrate/20190307200449_create_profile_wizard_answers.rb
+- lib/profile_wizard.rb
+- lib/profile_wizard/engine.rb
+- lib/profile_wizard/models.rb
+- lib/profile_wizard/models/profile.rb
+- lib/profile_wizard/models/question.rb
+- lib/profile_wizard/models/step.rb
+- lib/profile_wizard/version.rb
+- lib/tasks/profile_wizard_tasks.rake
+homepage: https://www.codeastra.com
+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.7.8
+signing_key: 
+specification_version: 4
+summary: Pluggable profile completion wizard
+test_files: []