quick_exam 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d26400fe1fe860ec5752c76d8cab490bda275bd0e6428df7ee568e02e579991
+  data.tar.gz: 97f74ccd29cc1f108376887666c6aafe943356a97d7c31a29d5478080fad28d9
+SHA512:
+  metadata.gz: ed2e374cc26f5c17dd8b7063d1fe7efe1eee5923f165f29db38b167ac3d9a777d587a5d2036541a2e5d0243a77969b1ffe6aa814d35e5863f5d540cafb47a5b5
+  data.tar.gz: be53d3d2bb983648b096ac7ac19fa6198103ba420c38ae9f3c38bb2bdd4a4c5e176cab14a72fc44811349302655a52937dec48d55b350bea4108a4a92a51c844

data/.gitignore

@@ -0,0 +1,15 @@
+.DS_Store
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+*.gem
+*/quick_exam_export/
+*.fld
+~*_sample.*

data/.ruby-version

@@ -0,0 +1 @@
+2.4.0

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+The changelog is tracked here but also in the [Releases section of the GitHub project](https://github.com/rubykachu/quick_exam/releases). The changelog only includes changes specific to the RubyGem.
+
+## v1.0.0
+
+- First release version `v1.0.0`
+- Support file txt, docx and Webpage html from Word

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at minh.tang@tomosia.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in quick_exam.gemspec
+gemspec
+
+gem 'nokogiri'
+gem 'sanitize', '4.6.6'
+gem 'docx', '0.5.0'
+
+group :development do
+  gem "rake", "~> 12.0"
+  gem 'pry'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Shota Fukumori (sora_h)
+
+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,157 @@
+# QuickExam
+
+[![Gem Version](https://badge.fury.io/rb/quick_exam.svg)](https://badge.fury.io/rb/quick_exam)
+
+You can shuffle or randomize quiz questions and answers. Shuffling is also an effective way of preventing cheating because no two learners get questions in the same order while taking the same quiz.
+
+The gem `quick_exam` **only supports txt, docx and Webpage html from Word** format. You can completely change the format of the questions and answers.
+
+
+| Description | Example |
+|-------------|------------------------|
+| Format for a Question: Not case sensitive. The starting must be letters | `Q`, `Question` or `Câu` etc... |
+| Format for an Answer: Not case sensitive. Starting with a letter or a number | `A`, `a` or `1`, `2` etc... |
+| Format for an Correct answer: Not case sensitive | `!!!T` |
+
+**Sample data**
+```
+Q1. Who are all ________ people?
+A. this
+B. those !!!T
+C. them
+D. that
+
+Q2. Claude is ________.
+A. Frenchman
+B. a French !!!T
+C. a Frenchman
+D. French man
+
+Q3. I ____ a car next year.
+A. buy
+B. am buying !!!T
+C. going to buy
+D. bought
+```
+
+## Installation
+
+Install the latest release yourself as:
+
+```bash
+$ gem install quick_exam
+```
+
+In Rails or others, add it to your Gemfile:
+
+```ruby
+gem 'quick_exam'
+```
+
+And then execute
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+### From CLI to export shuffle or randomize quiz question and answers
+
+Run command help
+
+```bash
+$ quick_exam help export
+```
+to show options:
+
+```
+Usage:
+  quick_exam export FILE_PATH [options]
+
+Options:
+  -q, [--shuffle-question=true|false]  # Shuffle the question
+                                       # Default: true
+
+  -a, [--shuffle-answer=true|false]    # Shuffle the answer
+                                       # Default: false
+
+  -s, [--same-answer=false]            # The same answer for all questionnaires
+                                       # Default: false
+
+  -Q, [--f-ques=Q]                     # Question format. Just prefix the question
+                                       # Default: Q
+
+  -C, [--f-corr=!!!T]                  # Correct answer format
+                                       # Default: !!!T
+
+  -c, [--count=2]                      # Number of copies to created
+                                       # Default: 2
+
+  -d, [--dest=~/quick_exam_export/]    # File storage path after export
+
+shuffled questions and answers then export file
+```
+
+### From script ruby to process raw data and get results after analysis
+
+
+```ruby
+analyzer = QuickExam::Analyzer.new(path_file, f_ques: '', f_corr: '')
+analyzer.analyze
+```
+
+The object `analyzer` will have methods:
+
+```bash
+.records       # Return the data after analyzing
+.total_line    # Return total line of the file
+.f_ques        # Return the format question
+.f_corr        # Return the format correct answer
+```
+
+To shuffle quiz question and answers
+
+```ruby
+analyzer.records.mixes(count, shuffle_question: true, shuffle_answer: false, same_answer: false)
+```
+
+The method `mixes` have 3 arguments:
+
+```bash
+count:               # Require. Number of copies to created
+shuffle_question:    # Optional. Shuffle quiz question. Default: true
+shuffle_answer:      # Optional. Shuffle answer. Default: false
+same_answer:         # Optional. Same answer for all questionnaires. Default: false
+```
+
+## Trick: Keep format Word
+
+_Commonly used for mathematical or chemical formats_
+
+`From Word > Save As > Save with format Webpage html`
+
+**Step 1:**
+![image](https://user-images.githubusercontent.com/26104119/93707761-8a5a7080-fb5b-11ea-9df5-ca34a603ab4b.png)
+
+**Step 2:**
+![image](https://user-images.githubusercontent.com/26104119/93707825-e1f8dc00-fb5b-11ea-8518-af07415ba4f3.png)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tm-minhtang/quick_exam/issues. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected
+
+1. Fork it
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Added some feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create new Pull Request
+
+---
+_Authors: Tang Quoc Minh [vhquocminhit@gmail.com]_

data/bin/console

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "quick_exam"
+
+def reload!(print = true)
+  puts 'Reloading ...' if print
+  root_dir = File.expand_path('..', __dir__)
+  reload_dirs = %w{lib}
+  Object.send(:remove_const, :"QuickExam")
+  reload_dirs.each do |dir|
+    Dir.glob("#{root_dir}/#{dir}/**/**/*.rb").reverse.each { |f| load(f) }
+  end
+  true
+end
+
+begin
+  require 'pry'
+  Pry.start
+rescue LoadError
+  require "irb"
+  IRB.start(__FILE__)
+end

data/bin/quick_exam

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+require 'quick_exam/cli'
+
+# silence deprecations warning
+ENV['THOR_SILENCE_DEPRECATION'] = '0'
+
+QuickExam::CLI.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/quick_exam.rb

@@ -0,0 +1,11 @@
+require 'nokogiri'
+require 'sanitize'
+require "quick_exam/version"
+require "quick_exam/core_ext"
+require "quick_exam/handle_error"
+require "quick_exam/analyzer"
+require "quick_exam/export"
+
+module QuickExam
+  # todo something
+end

data/lib/quick_exam/analyst/base_docx.rb

@@ -0,0 +1,57 @@
+require 'docx'
+require 'quick_exam/format'
+require 'quick_exam/record'
+require 'quick_exam/record_collection'
+require 'quick_exam/analyst/common'
+
+module QuickExam
+  module Analyst
+    class BaseDocx
+      include QuickExam::Format
+      attr_reader :records, :total_line
+
+      def initialize(file_path, f_ques:'' , f_corr:'')
+        raise ErrorAnalyze.new('No such file') unless File.exist? file_path
+        @file_path = file_path
+        @f_ques = f_ques
+        @f_corr = f_corr
+        @records = QuickExam::RecordCollection.new()
+      end
+
+      def analyze
+        data_standardize
+        self
+      rescue => e
+        raise ErrorAnalyze.new('Data can not analyze')
+      end
+
+      private
+
+      include QuickExam::Analyst::Common
+
+      def data_standardize
+        doc = Docx::Document.open(@file_path)
+        data = doc.paragraphs
+
+        @total_line = data.size
+        @object = QuickExam::Record.new()
+
+        data.each.with_index do |row, idx|
+          row = row.text
+          idx += 1 # The first row is 1
+
+          if end_of_line?(idx) || end_of_one_ticket_for_next_question?(row)
+            get_answer(row) # if the last line is answer then will get answer
+            collect_object_ticket
+          end
+
+          next if row.__blank?
+
+          next if get_answer(row)
+          next if get_question(row)
+        end
+        records
+      end
+    end
+  end
+end

data/lib/quick_exam/analyst/base_html.rb

@@ -0,0 +1,106 @@
+require 'quick_exam/format'
+require 'quick_exam/record'
+require 'quick_exam/record_collection'
+
+module QuickExam
+  class Analyst::BaseHTML
+    include QuickExam::Format
+    attr_reader :records, :total_line, :file
+
+    def initialize(file_path, f_ques: '' , f_corr: '')
+      raise ErrorAnalyze.new('No such file') unless File.exist? file_path
+      @file_path = file_path
+      @f_ques = f_ques
+      @f_corr = f_corr
+      @records = QuickExam::RecordCollection.new()
+    end
+
+    def analyze
+      data_standardize
+    end
+
+    private
+
+    include QuickExam::Analyst::Common
+
+    def data_standardize
+      @object = QuickExam::Record.new()
+
+      doc = File.open(@file_path) { |f| Nokogiri::HTML(f) }
+      data = doc.search('.WordSection1 p')
+
+      @total_line = data.size
+      data.each_with_index do |element, idx|
+        content_html = Sanitize.fragment(element, elements: ALLOWED_ELEMENTS).gsub(regex_ele_empty, '').__squish
+        idx += 1 # The first row is 1
+
+        if end_of_line?(idx) || end_of_one_ticket_for_next_question?(content_html)
+          get_answer_html(content_html) # if the last line is answer then will get answer
+          collect_object_ticket
+        end
+
+        next if element_empty? Sanitize.fragment(element)
+        next if get_answer_html(content_html)
+        next if get_question_html(content_html)
+      end
+    end
+
+    def get_answer_html(str)
+      return unless answer?(str)
+      ans = str.split(answer_mark_html(str)).last
+      return if ans.__blank?
+
+      ans = Nokogiri::HTML(ans).to_html
+      ans = Sanitize.fragment(ans, elements: ALLOWED_ELEMENTS)
+      ans = ans.split(@f_corr)[0].__squish
+
+      @object.answers << ans
+      get_correct_indexes_answer(str)
+    end
+
+    def get_question_html(str)
+      return if @object.answers.__present?
+      # Split question from question_mark and Get question
+      ques = str.split(question_mark_html(str)).last
+
+      # Chain question if not question and not answer
+      return @object.question += str if ques.__blank? && !answer?(str)
+
+      # fix unclosed HTML tags
+      ques = Nokogiri::HTML(ques).to_html
+      @object.question += Sanitize.fragment(ques, elements: ALLOWED_ELEMENTS).__squish
+    end
+
+    def question_mark_html(str)
+      dirty_f_ques = ''
+      str.chars.detect do |char|
+        dirty_f_ques += char
+        question?(dirty_f_ques)
+      end
+
+      # fix unclosed HTML tags
+      dirty_f_ques = Nokogiri::HTML(dirty_f_ques).to_html
+      Sanitize.fragment(dirty_f_ques, elements: ALLOWED_ELEMENTS).__squish
+    end
+
+    def answer_mark_html(str)
+      dirty_f_ans = ''
+      str.chars.detect do |char|
+        dirty_f_ans += char
+        answer?(dirty_f_ans)
+      end
+
+      # fix unclosed HTML tags
+      dirty_f_ans = Nokogiri::HTML(dirty_f_ans).to_html
+      Sanitize.fragment(dirty_f_ans, elements: ALLOWED_ELEMENTS).__squish
+    end
+
+    def element_empty?(str)
+      str.__squish.__blank? || (str =~ regex_ele_empty).__present?
+    end
+
+    def regex_ele_empty
+      /<[^\/>][^>]*>[\s]*<\/[^>]+>/
+    end
+  end
+end