northpass 0.0.2

data/lib/schoolkeep/fixture/stubs.rb

@@ -0,0 +1,106 @@
+require "ostruct"
+
+module Partnerships
+  class Educator < Class.new(OpenStruct)
+  end
+end
+
+Course = Class.new(OpenStruct)
+Locale = Class.new(OpenStruct)
+
+module ActionController
+  class Parameters < Class.new(Hash)
+  end
+end
+
+CategoryDecorator = Class.new(OpenStruct)
+
+module SchoolWebsite
+  class CourseDecorator < Course
+    def progress_text(_)
+      super()
+    end
+  end
+
+  ActivityDecorator = Class.new(OpenStruct)
+  CourseCatalogDecorator = Class.new(OpenStruct)
+  MyContentDecorator = Class.new(OpenStruct)
+  UpcomingRegisteredEventsDecorator = Class.new(OpenStruct)
+  TrainingSessionsDecorator = Class.new(OpenStruct)
+  TrainingSessionDecorator = Class.new(OpenStruct)
+end
+
+class Learner < Class.new(OpenStruct)
+  def access_course?(_)
+    enrolled_in_course(_)
+  end
+
+  def enrolled_in_course?(_)
+    super()
+  end
+end
+
+class Person < Class.new(OpenStruct)
+  def access_course?(_)
+    enrolled_in_course(_)
+  end
+
+  def enrolled_in_course?(_)
+    super()
+  end
+end
+
+module Schools
+  class Routes < Class.new(OpenStruct)
+  end
+end
+
+module Search
+  class CatalogResult < Class.new(OpenStruct)
+  end
+end
+
+module LearnerSyllabuses
+  ActivitiesCollection = Class.new(OpenStruct)
+  Activity = Class.new(OpenStruct)
+  Section = Class.new(OpenStruct)
+  SectionsCollection = Class.new(OpenStruct)
+  Syllabus = Class.new(OpenStruct)
+end
+
+module Draper
+  class CollectionDecorator < Array
+    alias :count :size
+  end
+end
+
+module ActiveRecord
+  module Associations
+    class CollectionProxy < Array
+    end
+  end
+end
+
+class Array
+  alias :count :size
+end
+
+class ColorScheme < Class.new(OpenStruct)
+  def initialize(*args)
+    super
+    to_h.each do |method_name, _|
+      define_singleton_method "#{method_name}?" do
+        val = send(method_name)
+        val != "" && !val.nil?
+      end
+    end
+  end
+end
+
+require "schoolkeep/scribble"
+Scribble::Registry.for Array do
+  method :count
+end
+
+Schoolkeep::Scribble.stub = true
+Schoolkeep::Scribble.register_models

data/lib/schoolkeep/gui_client.rb

@@ -0,0 +1,99 @@
+require "tk"
+require "schoolkeep/server"
+
+module Schoolkeep
+  class GuiClient
+    def initialize
+      choose_templates_directory_button
+      templates_directory_field
+      server_toggle_button
+
+      if not defined?(Ocra)
+        Tk.mainloop
+      end
+    end
+
+    def root
+      @root ||= TkRoot.new do
+        title "SchoolKeep Local Dev Server"
+        minsize 400, 100
+        iconphoto(
+          *%w(144 72 57 16).map do |size|
+            TkPhotoImage.new("file" => "media/sk-#{size}.gif")
+          end
+        )
+      end
+    end
+
+    def server_toggle_button
+      gui_client = self
+      @server_toggle_button ||= TkButton.new(root) do
+        text "Start Server"
+        command do
+          gui_client.toggle_server
+        end
+        pack
+      end
+    end
+
+    def templates_directory_frame
+      @templates_directory_frame ||= TkFrame.new(root) do
+        pack "side" => "top"
+      end
+    end
+
+    def templates_directory_field
+      @templates_directory_field ||= TkEntry.new(templates_directory_frame) do
+        pack "side" => "left"
+      end
+    end
+
+    def choose_templates_directory_button
+      gui_client = self
+      @choose_templates_directory_button ||= TkButton.new(templates_directory_frame) do
+        text "Choose Templates Directory"
+        command do
+          dir = gui_client.templates_directory_field.get
+          if dir == ""
+            dir = ENV["HOME"]
+          end
+          gui_client.templates_directory_field.set Tk::chooseDirectory("initialdir" => dir)
+        end
+        pack "side" => "right"
+      end
+    end
+
+    def toggle_server
+      if @server
+        server_stop
+      else
+        server_start
+      end
+    end
+
+    def server_start
+      templates_directory_field.state "readonly"
+      choose_templates_directory_button.state "disabled"
+      @server = Thread.new {
+        server = Server.new(
+          dir: templates_directory_field.get,
+          quiet: true
+        )
+        begin
+            server.start
+        ensure
+            server.shutdown
+        end
+      }
+      server_toggle_button.text "Stop Server"
+    end
+
+    def server_stop
+      @server.kill
+      @server = nil
+      server_toggle_button.text "Start Server"
+      templates_directory_field.state "normal"
+      choose_templates_directory_button.state "normal"
+    end
+  end
+end

data/lib/schoolkeep/scribble.rb

@@ -0,0 +1,480 @@
+require "scribble"
+require "ostruct"
+require "cgi"
+require "schoolkeep/scribble/methods/app"
+require "schoolkeep/scribble/methods/collection_each"
+require "schoolkeep/scribble/methods/display_search_form"
+require "schoolkeep/scribble/methods/filter_parameter_value"
+require "schoolkeep/scribble/methods/hide_search_box"
+require "schoolkeep/scribble/methods/l"
+require "schoolkeep/scribble/methods/limit"
+require "schoolkeep/scribble/methods/no_filter_selected_class"
+require "schoolkeep/scribble/methods/pluralize"
+require "schoolkeep/scribble/methods/query_parameter_value"
+require "schoolkeep/scribble/methods/script"
+require "schoolkeep/scribble/methods/t"
+
+Scribble::Registry.for Enumerable do
+  to_boolean { any? }
+
+  method :any?
+
+  # Logical operators
+  method :or,  Object, cast: 'to_boolean'
+  method :and, Object, cast: 'to_boolean'
+
+  # Equality
+  method :equals,  Enumerable, as: '=='
+  method :differs, Enumerable, as: '!='
+  method :equals,  Object, returns: false
+  method :differs, Object, returns: true
+end
+
+Scribble::Registry.for ActiveRecord::Associations::CollectionProxy do
+  to_boolean { any? }
+
+  # Logical operators
+  method :or,  Object, cast: 'to_boolean'
+  method :and, Object, cast: 'to_boolean'
+
+  # Equality
+  method :equals,  ActiveRecord::Associations::CollectionProxy, as: '=='
+  method :differs, ActiveRecord::Associations::CollectionProxy, as: '!='
+  method :equals,  Object, returns: false
+  method :differs, Object, returns: true
+end
+
+Scribble::Registry.for Draper::CollectionDecorator do
+  method :count
+  method :any?
+end
+
+module Schoolkeep
+  module Scribble
+    class << self
+      attr_accessor :stub
+
+      def register_models
+        if stub
+          models.each do |class_name, args|
+            begin
+              constantize(class_name)
+            rescue NameError
+              Object.const_set(class_name, Class.new(OpenStruct))
+            end
+          end
+        end
+
+        models.each do |class_name, args|
+          register_model(class_name, *args)
+        end
+      end
+
+      private
+
+      def register_model(class_name, boolean, block)
+        ::Scribble::Registry.instance.class_names.delete_if do |klass, name|
+          name == class_name
+        end
+
+        ::Scribble::Registry.instance.methods.reject! do |method|
+          method.receiver_class.name == class_name
+        end
+
+        klass = constantize(class_name)
+
+        ::Scribble::Registry.for klass do
+          name class_name
+          to_boolean { boolean }
+
+          # Logical operators
+          method :or,  Object, cast: 'to_boolean'
+          method :and, Object, cast: 'to_boolean'
+
+          # Equality
+          method :equals,  klass, as: '=='
+          method :differs, klass, as: '!='
+          method :equals,  Object, returns: false
+          method :differs, Object, returns: true
+        end
+
+        ::Scribble::Registry.for klass, &block
+      end
+
+      def models
+        @models ||= {}
+      end
+
+      def register(class_name, boolean: true, &block)
+        models[class_name.to_s] = [boolean, block]
+      end
+
+      def constantize(camel_cased_word)
+        names = camel_cased_word.split('::')
+
+        # Trigger a builtin NameError exception including the ill-formed constant in the message.
+        Object.const_get(camel_cased_word) if names.empty?
+
+        # Remove the first blank element in case of '::ClassName' notation.
+        names.shift if names.size > 1 && names.first.empty?
+
+        names.inject(Object) do |constant, name|
+          if constant == Object
+            constant.const_get(name)
+          else
+            candidate = constant.const_get(name)
+            next candidate if constant.const_defined?(name, false)
+            next candidate unless Object.const_defined?(name)
+
+            # Go down the ancestors to check it it's owned
+            # directly before we reach Object or the end of ancestors.
+            constant = constant.ancestors.inject do |const, ancestor|
+              break const    if ancestor == Object
+              break ancestor if ancestor.const_defined?(name, false)
+              const
+            end
+
+            # owner is in Object, so raise
+            constant.const_get(name, false)
+          end
+        end
+      end
+    end
+
+    register :Category do
+      method :active?
+      method :link
+      method :name
+    end
+
+    register :CustomPage do
+      to_string  { "custom_page: #{page_title}" }
+
+      # Attributes
+      method :page_title
+      method :headline
+      method :subheadline
+      method :image_url
+      method :content
+    end
+
+    register :School do
+      to_string  { "school: #{name}" }
+
+      # Attributes
+      method :disable_social_share?
+      method :filterable_categories # DEPRECATED
+      method :filtering_enabled?
+      method :has_custom_styles?
+      method :locales
+      method :logo_navigation_url
+      method :logo_url
+      method :my_content_label
+      method :my_content_path # DEPRECATED
+      method :name
+      method :public
+      method :search_enabled?
+      method :show_powered_by_school_keep?
+      method :sso_enabled?
+    end
+
+    register :WebsiteNavigation do
+      to_string  { "website navigation: #{name}" }
+
+      method :name
+      method :path
+      method :external?
+    end
+
+    register :WebsiteFooter do
+      to_string  { "website footer" }
+
+      method :show_navigation_links?
+      method :show_social_media_links?
+      method :show_customer_service_email?
+      method :school_customer_service_email
+      method :social_media_links
+    end
+
+    register :SocialMediaLink do
+      to_string  { "social media link: #{name}" }
+
+      method :link
+      method :name
+    end
+
+    register :Course do
+      to_string  { "course: #{name}" }
+
+      method :course_category_names
+      method :full_description
+      method :has_outline?
+      method :name
+      method :payment_required?
+      method :published_sections
+      method :ribbon
+      method :short_description
+      method :show_events?
+    end
+
+    register :VirtualEventSessionSummary do
+      to_string  { "virtual event session summary" }
+
+      method :virtual_event_name
+      method :provider_logo_url
+      method :virtual_event_start_url
+      method :starts_at
+      method :ends_at
+      method :join_link
+    end
+
+    register "Search::CatalogResult" do
+      method :count
+    end
+
+    register "SchoolWebsite::MyContentDecorator" do
+      to_string  { "my content decorator" }
+
+      method :courses
+      method :headline
+      method :subheadline
+    end
+
+    register :Section do
+      to_string { "section: #{name}" }
+
+      method :name
+      method :activities
+    end
+
+    register "SchoolWebsite::ActivityDecorator" do
+      method :completed?
+      method :list_class
+      method :milestone?
+      method :path
+      method :title
+    end
+
+    register "SchoolWebsite::CourseDecorator" do
+      to_string  { "course decorator: #{name}" }
+
+      method :about_label
+      method :buy_label
+      method :course_attempts_path
+      method :cover_path
+      method :details_path
+      method :details_url
+      method :enrollment_url
+      method :featured_image_url
+      method :formatted_price
+      method :forum_path
+      method :go_to_label
+      method :has_forum?
+      method :instructor_names
+      method :instructors
+      method :instructors_title
+      method :virtual_events_title
+      method :learner_can_retake?
+      method :list_image_url
+      method :new_order_path
+      method :outline_label
+      method :outline_path
+      method :partnership_names
+      method :partnerships
+      method :progress
+      method :progress_bar
+      method :progress_text, Person
+      method :progress_title
+      method :promo_video_embed
+      method :register_for_events
+      method :retake_course
+      method :social_links
+      method :start_or_continue
+      method :superscript
+      method :upcoming_event_sessions
+      method :view_label
+      method :virtual_events_path
+      method :discover_events_path
+    end
+
+    register "SchoolWebsite::CourseCatalogDecorator" do
+      to_string  { "course decorator: #{name}" }
+
+      method :headline
+      method :headline_empty_collection
+      method :subheadline
+      method :subheadline_empty_collection
+    end
+
+    register "SchoolWebsite::UpcomingRegisteredEventsDecorator" do
+      method :sessions
+      method :additional_sessions?
+    end
+
+    register "SchoolWebsite::TrainingSessionsDecorator" do
+      method :head
+      method :tail
+    end
+
+    register "SchoolWebsite::TrainingSessionDecorator" do
+      method :status
+      method :title
+      method :starts_at
+      method :waiting?
+      method :pending?
+      method :join_url
+      method :logmein?
+      method :in_person?
+      method :room_name
+      method :location_name
+    end
+
+    register "Partnerships::Educator" do
+      to_string { "partnership: #{name}" }
+
+      method :image_url
+      method :name
+      method :title
+      method :bio
+    end
+
+    register "LearnerSyllabuses::SectionsCollection" do
+    end
+
+    register "LearnerSyllabuses::ActivitiesCollection" do
+    end
+
+    register "LearnerSyllabuses::Section" do
+      method :activities
+      method :name
+      method :published_at
+      method :will_be_published?
+    end
+
+    register "LearnerSyllabuses::Activity" do
+      method :completed?
+      method :list_class
+      method :locked?
+      method :milestone?
+      method :path
+      method :title
+    end
+
+    register "LearnerSyllabuses::Syllabus" do
+      method :sections
+    end
+
+    register :Learner do
+      to_string  { "learner: #{name}" }
+
+      # Attributes
+      method :access_course?, Course
+      method :enrolled_in_course?, Course
+      method :filterable_categories
+      method :my_content_label
+      method :name
+      method :email
+      method :sso_uid
+      method :id
+      method :upcoming_registered_events
+    end
+
+    register :Person do
+      to_string  { "learner: #{name}" }
+
+      # Attributes
+      method :access_course?, Course
+      method :enrolled_in_course?, Course
+      method :filterable_categories
+      method :my_content_label
+      method :name
+      method :email
+      method :sso_uid
+      method :id
+      method :upcoming_registered_events
+    end
+
+    register :GuestLearner, boolean: false do
+      to_string  { "guest learner" }
+
+      method :access_course?, Course
+      method :enrolled_in_course?, Course
+      method :filterable_categories
+      method :my_content_label
+      method :name
+      method :email
+      method :sso_uid
+      method :id
+      method :upcoming_registered_events
+    end
+
+    register :GuestPerson, boolean: false do
+      to_string  { "guest learner" }
+
+      method :access_course?, Course
+      method :enrolled_in_course?, Course
+      method :filterable_categories
+      method :my_content_label
+      method :name
+      method :email
+      method :sso_uid
+      method :id
+      method :upcoming_registered_events
+    end
+
+    register :Homepage do
+      to_string  { "homepage" }
+
+      method :headline
+      method :subheadline
+      method :artwork_url
+      method :featured_courses_headline
+      method :featured_courses_subheadline
+      method :published_featured_courses
+    end
+
+    register "Schools::Routes" do
+      to_string { "school routes" }
+
+      method :my_courses_path
+      method :my_content_path
+      method :my_profile_path
+      method :log_out_path
+      method :log_in_path
+      method :sign_up_path
+
+      method :color_scheme_path
+      method :custom_styles_path
+      method :schoolkeep_v3_styles_url
+      method :school_website_search_path
+    end
+
+    register "ColorScheme" do
+      to_string { "Color Scheme" }
+
+      method :background_color
+      method :background_font_color
+      method :button_color
+      method :button_font_color
+      method :button_hover_color
+      method :banner_font_color
+      method :header_color
+      method :header_font_color
+      method :header_font_hover_color
+    end
+
+    register "BaseApp" do
+      to_string { "Base App" }
+
+      method :active?
+      method :inactive?
+    end
+
+    register :Locale do
+      to_string { "Locale" }
+
+      method :code
+      method :name
+    end
+  end
+end