northpass 0.0.2

data/spec/methods/pluralize_spec.rb

@@ -0,0 +1,41 @@
+require "scribble"
+require "schoolkeep/scribble/methods/pluralize"
+require "active_support/core_ext/string/inflections"
+
+module Scribble::Methods
+  RSpec.describe Pluralize do
+    describe "#pluralize" do
+      after do
+        I18n.locale = I18n.default_locale
+        ActiveSupport::Inflector.inflections(:es) do |inflect|
+          inflect.clear
+        end
+      end
+
+      it "uses locale to pluralize string if none specified" do
+        ActiveSupport::Inflector.inflections(:es) do |inflect|
+          inflect.clear
+
+          inflect.plural(/$/, 's')
+          inflect.plural(/([^aeéiou])$/i, '\1es')
+        end
+
+        I18n.locale = :es
+
+        expect(render("{{pluralize(0, 'ley')}}")).to eq "leyes"
+        expect(render("{{pluralize(1, 'ley')}}")).to eq "ley"
+        expect(render("{{pluralize(2, 'ley')}}")).to eq "leyes"
+      end
+
+      it "uses specified attribute to pluralize string" do
+        expect(render("{{pluralize(0, 'one', 'many')}}")).to eq "many"
+        expect(render("{{pluralize(1, 'one', 'many')}}")).to eq "one"
+        expect(render("{{pluralize(2, 'one', 'many')}}")).to eq "many"
+      end
+    end
+
+    def render(source)
+      Scribble::Template.new(source).render
+    end
+  end
+end

data/spec/methods/query_parameter_value_spec.rb

@@ -0,0 +1,26 @@
+require "scribble"
+require "schoolkeep/scribble/methods/query_parameter_value"
+
+module Scribble::Methods
+  RSpec.describe QueryParameterValue do
+    describe "#query_parameter_value" do
+      it "escapes HTML" do
+        rendered = render("<input value='{{ query_parameter_value }}>'", "test_template")
+
+        expect(rendered).to eq \
+          "<input value='&#39;&gt;&lt;script&gt;alert(&#39;HAXXX&#39;)&lt;/script&gt;>'"
+      end
+    end
+
+    def render(source, template_name, locale = :en)
+      Scribble::Template.new(source).render(
+        variables: {
+          template_name: template_name,
+          params: {
+            q: "'><script>alert('HAXXX')</script>"
+          }
+        }
+      )
+    end
+  end
+end

data/spec/methods/script_spec.rb

@@ -0,0 +1,52 @@
+require "scribble"
+require "schoolkeep/scribble/methods/script"
+
+module Scribble::Methods
+  RSpec.describe Script do
+    describe "#script" do
+      it "renders a script tag for the fingerprinted asset" do
+        rendered = render("{{ script('hello') }}", "test_template")
+
+        expect(rendered).to eq "<script src='/custom_assets/abc123/hello-zxy987.js'></script>"
+      end
+
+      context "when there is an asset host" do
+        it "renders the host" do
+          rendered = render(
+            "{{ script('hello') }}",
+            "test_template",
+            asset_host: "foo.com"
+          )
+
+          expect(rendered).to eq \
+            "<script src='foo.com/custom_assets/abc123/hello-zxy987.js'></script>"
+        end
+      end
+    end
+
+    def render(source, template_name, locale: :en, asset_host: nil)
+      url_helpers = double(:url_helpers)
+      routes = double(:routes, url_helpers: url_helpers)
+      school = double(:school, uuid: "abc123", routes: routes)
+      template = double(:template, fingerprint: "zxy987")
+      custom_templates = double(:custom_templates, find_by!: template)
+      allow(url_helpers).to receive(:custom_asset_url) do |school_uuid, asset|
+        [
+          asset_host,
+          "custom_assets",
+          school_uuid,
+          asset
+        ].join("/")
+      end
+
+      Scribble::Template.new(source).render(
+        variables: {
+          asset_host: asset_host,
+          custom_templates: custom_templates,
+          current_school: school,
+          template_name: template_name
+        }
+      )
+    end
+  end
+end

data/spec/methods/t_spec.rb

@@ -0,0 +1,33 @@
+require "scribble"
+require "schoolkeep/scribble/methods/t"
+
+module Scribble::Methods
+  RSpec.describe T do
+    describe "#t" do
+      it "delegates to I18n and allows for short keys" do
+        foo_rendered = render("{{t('.foo')}}", "test_template")
+        bar_rendered = render("{{t('bar')}}", "test_template")
+
+        expect(foo_rendered).to eq "bar"
+        expect(bar_rendered).to eq "baz"
+      end
+
+      context "when the template name has a locale suffix" do
+        it "renders the correct translation" do
+          foo_rendered = render("{{t('.foo')}}", "test_template.es", :es)
+          bar_rendered = render("{{t('bar')}}", "test_template.es", :es)
+
+          expect(foo_rendered).to eq "el_bar"
+          expect(bar_rendered).to eq "el_baz"
+        end
+      end
+    end
+
+    def render(source, template_name, locale = :en)
+      I18n.locale = locale
+      Scribble::Template.new(source).render(
+        variables: {template_name: template_name}
+      )
+    end
+  end
+end

data/spec/server_spec.rb

@@ -0,0 +1,81 @@
+require "schoolkeep/server"
+require "faraday"
+
+module Schoolkeep
+  RSpec.describe Server do
+    describe "#server" do
+      it "serves the templates locally" do
+        I18n.locale = :en
+        Dir.mktmpdir do |dir|
+          Dir.mkdir "#{dir}/templates"
+          File.write "#{dir}/templates/_head.html.sktl", "<!-- HTML_HEAD -->"
+          File.write "#{dir}/templates/_header.html.sktl", "HEADER {{t('.courses')}}"
+          File.write "#{dir}/templates/_footer.html.sktl", "FOOTER {{t('.connect')}}"
+          File.write "#{dir}/templates/custom_page.html.sktl", "BODY {{custom_page.page_title}}"
+          Dir.mkdir "#{dir}/config"
+          File.write "#{dir}/config/fixtures.yml", fixtures.to_yaml
+
+          port = find_available_port
+
+          @server_thread = Thread.new do
+            Server.new(dir: dir, port: port, quiet: true).start
+          end
+
+          Timeout.timeout(60) { @server_thread.join(0.1) until responsive?(port) }
+
+          response = Faraday.get("http://localhost:#{port}/custom_page.html.sktl")
+
+          expect(response.body).to include "HTML_HEAD"
+          expect(response.body).to include "HEADER"
+          expect(response.body).to include "school_website-custom_pages school_website-custom_pages-show"
+          expect(response.body).to include I18n.t("custom_templates._header.courses")
+          expect(response.body).to include "BODY"
+          expect(response.body).to include page_title
+          expect(response.body).to include "FOOTER"
+          expect(response.body).to include I18n.t("custom_templates._footer.connect")
+        end
+      end
+
+      after do
+        @server_thread.exit
+      end
+
+      def responsive?(port)
+        return false if @server_thread && @server_thread.join(0)
+
+        res = Faraday.get("http://localhost:#{port}/")
+
+        if res.success?
+          return res.body.include?("custom_page.html.sktl")
+        end
+      rescue Faraday::ConnectionFailed
+        return false
+      end
+
+      def port
+        @port ||= find_available_port
+      end
+
+      def fixtures
+        {
+          "templates" => {
+            "custom_page.html.sktl" => {
+              custom_page: { page_title: page_title}
+            }
+          }
+        }
+      end
+
+      def page_title
+        @page_title ||= "This is an awesome title"
+      end
+
+      def find_available_port
+        server = TCPServer.new('127.0.0.1', 0)
+        server.addr[1]
+      ensure
+        server.close if server
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,48 @@
+require 'delegate'
+
+module Support
+  GEM_ROOT = File.expand_path("../../", __FILE__)
+  class WarningFilter < DelegateClass(IO)
+    def write(line)
+      super if line.start_with?(GEM_ROOT)
+    end
+  end
+end
+
+$stderr = Support::WarningFilter.new($stderr)
+
+require "pry"
+require "i18n"
+
+RSpec.configure do |config|
+  config.filter_run_excluding schoolkeep_client: true
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
+
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 10
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end
+
+I18n.available_locales = [:en, :es]
+I18n.backend.store_translations(:en, {bar: "baz", custom_templates: { test_template: { foo: "bar" }}})
+I18n.backend.store_translations(:es, {bar: "el_baz", custom_templates: { test_template: { foo: "el_bar" }}})

data/spec/views/asset_cache_spec.rb

@@ -0,0 +1,24 @@
+require "schoolkeep/views/asset_cache"
+
+module Schoolkeep
+  module Views
+    RSpec.describe AssetCache do
+      it "retreives full asset urls and only calls get once" do
+        asset_cache = AssetCache.new("https://app.northpass.com")
+        allow(asset_cache).to receive(:get) { "https://app.northpass.com/assets/sk-favicon.ico" }
+
+        asset_url = asset_cache["/assets/sk-favicon.ico"]
+
+        expect(asset_url).to eq("https://app.northpass.com/assets/sk-favicon.ico")
+        expect(asset_cache["/assets/sk-favicon.ico"]).to eq asset_url
+        expect(asset_cache).to have_received(:get).once
+      end
+
+      it "returns the asset path of an asset that is not found" do
+        asset_cache = AssetCache.new("https://app.northpass.com")
+        asset_url = asset_cache["/assets/not-found-image-test.png"]
+        expect(asset_url).to eq "/assets/not-found-image-test.png"
+      end
+    end
+  end
+end

data/spec/views/color_scheme_spec.rb

@@ -0,0 +1,15 @@
+require "schoolkeep/views/color_scheme"
+
+module Schoolkeep
+  module Views
+    RSpec.describe ColorScheme do
+      describe "#render" do
+        it "renders color scheme properly" do
+          color_scheme = Fixture.for("styles.css.sktl")[:color_palette]
+          color_scheme_css = ColorScheme.new("color_scheme").render
+          expect(color_scheme_css).to include color_scheme.button_color
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,223 @@
+--- !ruby/object:Gem::Specification
+name: northpass
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Ryan Ong
+- SchoolKeep Developers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: scribble
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- ryan@northpass.com
+- dev@northpass.com
+executables:
+- sk
+- sk_gui
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".pairs"
+- ".rspec"
+- Gemfile
+- Gemfile.ocra
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/sk
+- bin/sk_gui
+- circle.yml
+- config/ca-bundle.crt
+- config/color_scheme.css.erb
+- config/fixtures.yml
+- config/learning.html.erb
+- config/learning_color_scheme.css.erb
+- config/locale.yml
+- config/school_website.html.erb
+- lib/schoolkeep.rb
+- lib/schoolkeep/cli.rb
+- lib/schoolkeep/client.rb
+- lib/schoolkeep/fixture.rb
+- lib/schoolkeep/fixture/stubs.rb
+- lib/schoolkeep/gui_client.rb
+- lib/schoolkeep/scribble.rb
+- lib/schoolkeep/scribble/methods/app.rb
+- lib/schoolkeep/scribble/methods/collection_each.rb
+- lib/schoolkeep/scribble/methods/display_search_form.rb
+- lib/schoolkeep/scribble/methods/filter_parameter_value.rb
+- lib/schoolkeep/scribble/methods/hide_search_box.rb
+- lib/schoolkeep/scribble/methods/l.rb
+- lib/schoolkeep/scribble/methods/limit.rb
+- lib/schoolkeep/scribble/methods/no_filter_selected_class.rb
+- lib/schoolkeep/scribble/methods/pluralize.rb
+- lib/schoolkeep/scribble/methods/query_parameter_value.rb
+- lib/schoolkeep/scribble/methods/script.rb
+- lib/schoolkeep/scribble/methods/t.rb
+- lib/schoolkeep/server.rb
+- lib/schoolkeep/template.rb
+- lib/schoolkeep/template_names.rb
+- lib/schoolkeep/version.rb
+- lib/schoolkeep/views/asset_cache.rb
+- lib/schoolkeep/views/color_scheme.rb
+- lib/schoolkeep/views/layout.rb
+- media/schoolkeep.ico
+- media/sk-144.gif
+- media/sk-16.gif
+- media/sk-57.gif
+- media/sk-72.gif
+- schoolkeep.gemspec
+- spec/cli_spec.rb
+- spec/features/cli_spec.rb
+- spec/features/client_spec.rb
+- spec/fixture_spec.rb
+- spec/methods/filter_parameter_value_spec.rb
+- spec/methods/pluralize_spec.rb
+- spec/methods/query_parameter_value_spec.rb
+- spec/methods/script_spec.rb
+- spec/methods/t_spec.rb
+- spec/server_spec.rb
+- spec/spec_helper.rb
+- spec/views/asset_cache_spec.rb
+- spec/views/color_scheme_spec.rb
+homepage: https://github.com/SchoolKeep/schoolkeep-ruby
+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.6.11
+signing_key: 
+specification_version: 4
+summary: A cli to develop custom templates for and upload to SchoolKeep.
+test_files: []