lcms-engine 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88efc618857b500fa9f4b31269da6e6ea6a0a145a226d2e7a49a27b7c55d110c
-  data.tar.gz: 415213ff1df9648d44a20769e4b71dae28fc5ad4bd9d351d0ca7e04f1ee5788e
+  metadata.gz: 5c37201e439f0704a64bb50c1b520eda59af5407d1e76389ec579532142ce08a
+  data.tar.gz: 03d52081094d087b2b3fe1090a86a9e153fdcd6fab33510e19ea1809ff4d7a29
 SHA512:
-  metadata.gz: 13e737a28539e68498435df2c79c9b8e4b3e088cdd50e24172365fe3835923664381c7a16dc076fb4b5983e6797e2ae940399d362bd11f8e557b8579d4d9e3fd
-  data.tar.gz: 184b331a41a3836775f235288015d4a2b1aa9d5d9053bb0bfb1eef04fa963005c89044082b44afc5ba3b874f73cb1c5eeb69a6afe755a8fd8a040b5d0446310d
+  metadata.gz: 5572bde25038a2a11c02380993d600a8ba864d1a4d0f2ca4f4369c9f487e2ccc230c742d3d4ede4eae7a9765b1dda1ca6117ac78528802eabbf64dc3d8ac8b27
+  data.tar.gz: 1310db2346532587a79938b12711e3e7bc844790efe0675ad5aed13c0b8357d441ba37b9b6befe18357f1f4cbfd8fd5ea77702f51466c1b43364b8764b712527

data/CHANGELOG.md

@@ -4,9 +4,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://github.com/learningtapestry/lcms-engine/compare/v0.4.0...HEAD)
+## [Unreleased](https://github.com/learningtapestry/lcms-engine/compare/v0.4.1...HEAD)
 
-## [Unreleased](https://github.com/learningtapestry/lcms-engine/compare/v0.3.1...v0.4.0)
+## [0.4.1](https://github.com/learningtapestry/lcms-engine/compare/v0.4.0...v0.4.1) - 2022.10.13
+
+### Changed
+
+- `Lcms::Engine::AdminMaterialsQuery` now filters by metadata in case-insensitive way  - [@paranoicsan](https://github.com/paranoicsan)
+
+## [0.4.0](https://github.com/learningtapestry/lcms-engine/compare/v0.3.1...v0.4.0) - 2022.09.28
 
 ### Added
 

data/Gemfile.lock

@@ -10,7 +10,7 @@ GIT
 PATH
   remote: .
   specs:
-    lcms-engine (0.3.1)
+    lcms-engine (0.4.1)
       active_model_serializers (~> 0.10.10)
       activejob-retry (~> 0.6.3)
       acts-as-taggable-on (~> 7.0)

data/README.md

@@ -10,22 +10,16 @@ Our initial goal is gathering the common code among the current LCMS implementat
 (Odell, Unbound ED and OpenSciEd) and provide a unified codebase that can be maintained and developed
 separately, simplifying the client applications in the process.
 
+## Requirements
+- Ruby 2.7.x
+- Rails 6.1 or higher
+- Postgres 9.6 or higher
+
 ## Current development
 
 | Branch | Rails version |
 |--------|---------------|
-| master | Rails 6.1.4.6 |
-| 0.3.x  | Rails 5.2.4.5 |
-
-This is still a [work in progress](https://github.com/learningtapestry/lcms-engine/issues/3). The
-initial phase of the project consisted in extracting as much code as possible from the client
-projects and set the engine as the core foundation for further development and optimizations.
-
-Once the integrations with the client projects are successful, phase 1 will be complete and we'll be
-able to start phase 2, which ideally should involve optimizing the code and giving the engine some
-default features and customization possibilities. This should allow any Rails application to use a
-basic LCMS that works out of the box just by including the gem and setting some configuration
-options.
+| master | Rails 6.1.7   |
 
 ## Guidelines
 
@@ -82,17 +76,9 @@ Other kinds of assets, like ERB views, images, stylesheets or javascript files,
 overridden as easily as Ruby classes and modules, but you can always provide your own versions of
 the same files, overwriting the ones provided by the engine.
 
-## Requirements
-- Ruby 2.7 or higher
-- Rails 6.1 or higher
-- Postgres 9.6 or higher
-
 ## Installation
 Add this to the Gemfile:
 ```ruby
-gem 'lcms-engine','~> 0.3' # Rails 5.2
-```
-```ruby
 gem 'lcms-engine' # Rails 6.1
 ```
 

data/app/queries/lcms/engine/admin_materials_query.rb

@@ -30,7 +30,7 @@ module Lcms
 
           @scope =
             if STRICT_METADATA.include?(key.to_s)
-              @scope.where_metadata(key => q[key])
+              @scope.where_metadata(key => q[key].to_s.downcase)
             else
               @scope.where_metadata_like(key, q[key])
             end

data/docs/how-to-build-and-publish.md

@@ -1 +1,14 @@
 # How to build and publish gem
+
+Increase the version in `lib/lcms/engine/version.rb` and update `CHANGELOG.md`.
+
+Build the gem
+```bash
+$ gem build lcms-engine.gemspec
+```
+
+Publish it replacing `x-y-z` with correct version number.
+```bash
+$ gem signin
+$ gem push lcms-engine-x-y-z.gem
+```

data/docs/pdf-generation.md

@@ -0,0 +1,31 @@
+# PDF Generation
+
+We're using [puppeteer](https://pptr.dev/) with headless chrome for PDF generation.
+
+## PDF security policy
+After fresh server installation ImageMagick security policies have to be updated. Complete the following steps:
+
+1. Locate the file `/etc/ImageMagick-6/policy.xml`
+2. Find the policy for PDF format. It looks like this
+```xml
+<policy domain="coder" rights="none" pattern="PDF" />
+```
+3. Change it to this
+```xml
+<policy domain="coder" rights="read|write" pattern="PDF" />
+```
+
+## Local development
+1. install google chrome (see details on #google-chrome-version)
+2. set `ENABLE_BASE64_CACHING` as `false` or don't forger to clean cache on pdf related css/images changes (see below)
+3. install `puppeteer`: `nvm use && yarn install`
+4. set up own s3 bucket to avoid overwriting conflicts (`AWS_S3_BUCKET_NAME`)
+
+## Deployment
+1. on setting up new stack: add blank pages to s3 bucket (`rake openscied_core:s3_blank_page`)
+2. on deploying new version with changes at pdf related css/images: clean cached assets (`rake cache:reset_base64`)
+
+## Google Chrome version
+Chrome version is set as `70`, if we need to use newer release
+1. check PDF generation
+2. change deployment [hook](https://github.com/learningtapestry/openscied-lcms/blob/master/.cloud66/install_chrome.sh#L3) and redeploy (_NOTE_: maybe add `CHROME_VERSION` env variable?)

data/lcms-engine.gemspec

@@ -15,11 +15,17 @@ Gem::Specification.new do |s|
   s.summary = 'Rails engine for LCMS applications'
   s.description = 'Implements common components and features for Rails-based LCMS systems'
   s.license = 'Apache-2.0'
-  s.metadata['rubygems_mfa_required'] = 'true'
+  s.metadata = {
+    'homepage_uri' => 'https://github.com/learningtapestry/lcms-engine',
+    'changelog_uri' => 'https://github.com/learningtapestry/lcms-engine/blob/master/CHANGELOG.md',
+    'rubygems_mfa_required' => 'true',
+    'source_code_uri' => 'https://github.com/learningtapestry/lcms-engine',
+    'bug_tracker_uri' => 'https://github.com/learningtapestry/lcms-engine/issues'
+  }
 
   s.files = `git ls-files`.split("\n")
 
-  s.required_ruby_version = '>= 2.7'
+  s.required_ruby_version = '~> 2.7'
 
   s.add_dependency 'activejob-retry', '~> 0.6.3'
   s.add_dependency 'active_model_serializers', '~> 0.10.10'

data/lib/lcms/engine/version.rb

@@ -2,7 +2,7 @@
 
 module Lcms
   module Engine
-    VERSION = '0.4.0'
+    VERSION = '0.4.1'
     RAILS_5_VERSION = 5.2
   end
 end

data/spec/queries/lcms/engine/admin_materials_query_spec.rb

@@ -21,14 +21,21 @@ describe Lcms::Engine::AdminMaterialsQuery do
     end
 
     context 'strict metadata fields' do
-      let(:query) { { lesson: 1, grade: 'grade 1', subject: Faker::Lorem.word } }
+      let(:query) { { lesson: 1, grade: 'Grade 1', subject: Faker::Lorem.word } }
 
       it 'filters by metadata using explicit comparison' do
         expect(scope).to receive(:where_metadata_like).with(:lesson, 1).and_return(scope)
-        expect(scope).to receive(:where_metadata).with(query.slice(:grade)).and_return(scope)
+        expect(scope).to receive(:where_metadata).with(hash_including(grade: query[:grade].downcase)).and_return(scope)
         expect(scope).to receive(:where_metadata).with(query.slice(:subject)).and_return(scope)
         subject
       end
+
+      it 'filters case-insensitive' do
+        allow(scope).to receive(:where_metadata).with(query.slice(:subject)).and_return(scope)
+        allow(scope).to receive(:where_metadata_like).with(:lesson, 1).and_return(scope)
+        expect(scope).to receive(:where_metadata).with(hash_including(grade: query[:grade].downcase)).and_return(scope)
+        subject
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lcms-engine
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Alexander Kuznetsov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-28 00:00:00.000000000 Z
+date: 2022-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob-retry
@@ -2027,6 +2027,7 @@ files:
 - docs/env-variables.md
 - docs/google-cloud-platform-setup.md
 - docs/how-to-build-and-publish.md
+- docs/pdf-generation.md
 - lcms-engine.gemspec
 - lib/asset_helper.rb
 - lib/doc_template.rb
@@ -2391,14 +2392,18 @@ homepage: https://github.com/learningtapestry/lcms-engine
 licenses:
 - Apache-2.0
 metadata:
+  homepage_uri: https://github.com/learningtapestry/lcms-engine
+  changelog_uri: https://github.com/learningtapestry/lcms-engine/blob/master/CHANGELOG.md
   rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/learningtapestry/lcms-engine
+  bug_tracker_uri: https://github.com/learningtapestry/lcms-engine/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement