guide 0.0.1 → 0.5.0

data/app/views/layouts/guide/scenario/default.html.erb

@@ -0,0 +1 @@
+<%= yield %>

data/app/views/layouts/guide/scenario/default.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/config/initializers/assets.rb

@@ -0,0 +1 @@
+Rails.application.config.assets.precompile += ['guide/application.js', 'guide/scenario.js']

data/config/locales/models/guide/monkey.en.yml

@@ -0,0 +1,6 @@
+en:
+  guide:
+    monkey:
+      invalid_node: "I can't give you what you're looking for because a node in your path (%{node_id}) doesn't exist.\nPerhaps you need to add it to its parent using `contains :%{node_id}`."
+
+      invalid_starting_node: "I can't give you what you're looking for because the node that you told me to start from doesn't exist. This means that something is fundamentally wrong with your setup."

data/config/locales/views/guide/nodes/_structure.en.yml

@@ -0,0 +1,7 @@
+en:
+  guide:
+    nodes:
+      structure:
+        format_heading:
+          html: "HTML version"
+          text: "Plain text version"

data/config/routes.rb

@@ -0,0 +1,6 @@
+Guide::Engine.routes.draw do
+  root :to => 'nodes#show'
+
+  get 'scenario/:scenario_id/:scenario_format/for/*node_path' => 'scenarios#show', :as => 'scenario'
+  get '*node_path' => 'nodes#show', :as => 'node'
+end

data/lib/guide.rb

@@ -0,0 +1,12 @@
+require "guide/engine"
+require "guide/configuration"
+
+module Guide
+  def self.configuration
+    @@configuration ||= Guide::Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/guide/authorisation_spec_helper.rb

@@ -0,0 +1,83 @@
+module Guide::AuthorisationSpecHelper
+  RSpec.shared_context "the user is allowed to see the active node" do
+    before do
+      allow(controller).to receive(:injected_authorisation_system).
+        and_return(authorisation_system)
+      allow(controller).to receive(:injected_authentication_system).
+        and_return(authentication_system)
+      allow(Guide::Bouncer).to receive(:new).with(
+        authorisation_system: authorisation_system
+      ).and_return(bouncer)
+      allow(bouncer).to receive(:user_can_access?).
+        with(active_node).and_return(true)
+    end
+
+    let(:authentication_system) { instance_double(Guide::DefaultAuthenticationSystem) }
+    let(:authorisation_system) { instance_double(Guide::DefaultAuthorisationSystem) }
+    let(:content_node) { Guide::Content.new }
+    let(:active_node) do
+      Guide::Monkey.new(content_node, bouncer).fetch_node(node_path)
+    end
+    let(:bouncer) do
+      instance_double(Guide::Bouncer,
+                      :user_can_access? => true,
+                      :user_is_privileged? => false)
+    end
+  end
+
+  RSpec.shared_context "the user is not allowed to see the active node" do
+    before do
+      allow(controller).to receive(:injected_authorisation_system).
+        and_return(authorisation_system)
+      allow(controller).to receive(:injected_authentication_system).
+        and_return(authentication_system)
+      allow(Guide::Bouncer).to receive(:new).with(
+        authorisation_system: authorisation_system
+      ).and_return(bouncer)
+      allow(bouncer).to receive(:user_can_access?).
+        with(active_node).and_return(false)
+    end
+
+    let(:authentication_system) { instance_double(Guide::DefaultAuthenticationSystem) }
+    let(:authorisation_system) { instance_double(Guide::DefaultAuthorisationSystem) }
+    let(:content_node) { Guide::Content.new }
+    let(:active_node) do
+      Guide::Monkey.new(content_node, bouncer).fetch_node(node_path)
+    end
+    let(:bouncer) do
+      instance_double(Guide::Bouncer,
+                      :user_can_access? => true,
+                      :user_is_privileged? => false)
+    end
+  end
+
+  RSpec.shared_context "the user is allowed to see the scenario" do
+    before do
+      allow(bouncer).to receive(:user_can_access?).
+        with(scenario).and_return(true)
+    end
+
+    let(:scenario) { active_node.scenarios[scenario_id] }
+  end
+
+  RSpec.shared_context "the user is not allowed to see the scenario" do
+    before do
+      allow(bouncer).to receive(:user_can_access?).
+        with(scenario).and_return(false)
+    end
+
+    let(:scenario) { active_node.scenarios[scenario_id] }
+  end
+
+  RSpec.shared_context "we are in a development environment" do
+    before do
+      allow(Rails).to receive(:env).and_return(double(:development? => true))
+    end
+  end
+
+  RSpec.shared_context "we are not in a development environment" do
+    before do
+      allow(Rails).to receive(:env).and_return(double(:development? => false))
+    end
+  end
+end

data/lib/guide/configuration.rb

@@ -0,0 +1,29 @@
+class Guide::Configuration
+  attr_accessor :asset_path_for_logo,
+    :company_name,
+    :controller_class_to_inherit,
+    :default_layout_for_scenarios,
+    :default_javascripts_for_documents,
+    :default_javascripts_for_structures,
+    :default_stylesheets_for_documents,
+    :default_stylesheets_for_structures,
+    :guide_name,
+    :helper_module_to_globally_include,
+    :local_variable_for_view_model,
+    :supported_locales
+
+  def initialize
+    @asset_path_for_logo = ''
+    @company_name = 'Your Awesome Company'
+    @controller_class_to_inherit = 'ApplicationController'
+    @default_layout_for_scenarios = 'layouts/guide/scenario/default'
+    @default_javascripts_for_documents = []
+    @default_javascripts_for_structures = []
+    @default_stylesheets_for_documents = []
+    @default_stylesheets_for_structures = []
+    @guide_name = 'Your Awesome Guide'
+    @helper_module_to_globally_include = 'Guide::ApplicationHelper::DefaultInclude'
+    @local_variable_for_view_model = :view
+    @supported_locales = { "English" => "en" }
+  end
+end

data/lib/guide/consistency_spec_helper.rb

@@ -0,0 +1,33 @@
+module Guide::ConsistencySpecHelper
+  RSpec.shared_examples_for "a guide structure and a real view model" do
+    described_class.new.scenarios.first.tap do |id, scenario|
+      context "\n\n  for scenario #{scenario.name}\n    " do
+        let(:guide_view_model) { scenario.view_model }
+
+        it "the Guide::ViewModel implements the real view model's interface\n" do
+          expect_implemented_interface(guide_view_model, real_view_model)
+        end
+
+        it "the real view model implements the Guide::ViewModel's interface\n" do
+          expect_implemented_interface(real_view_model, guide_view_model)
+        end
+      end
+    end
+  end
+
+  private
+
+  def expect_implemented_interface(object, interface)
+    expect(methods_defined_on(object)).
+      to include(*methods_defined_on(interface)),
+      "I expected your #{object.class.name} to implement all of the methods on your #{interface.class.name}"
+  end
+
+  def methods_defined_on(object)
+    if object.kind_of?(Guide::ViewModel)
+      object.guide_view_model_interface_methods
+    else
+      object.methods - Module.instance_methods
+    end.sort
+  end
+end

data/lib/guide/engine.rb

@@ -0,0 +1,9 @@
+module Guide
+  class Engine < ::Rails::Engine
+    isolate_namespace Guide
+
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+    end
+  end
+end

data/lib/guide/version.rb

@@ -0,0 +1,3 @@
+module Guide
+  VERSION = "0.5.0"
+end

data/lib/tasks/guide_tasks.rake

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

metadata

@@ -1,29 +1,221 @@
 --- !ruby/object:Gem::Specification
 name: guide
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.5.0
 platform: ruby
 authors:
-- Jiexin huang
-autorequire: 
+- Luke Arndt
+- Jordan Lewis
+- Jiexin Huang
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-28 00:00:00.000000000 Z
-dependencies: []
-description: Living styleguide for your Rails app
-email: hjx500@gmail.com
+date: 2021-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  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: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Document your Rails application with a living component library and styleguide
+email:
+- luke@arndt.io
+- jordan@lewis.io
+- hjx500@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- Gemfile
-- guide.gemspec
-homepage: http://rubygems.org/gems/guide
+- LICENSE
+- Rakefile
+- app/assets/javascripts/guide/application.js
+- app/assets/javascripts/guide/scenario.js
+- app/assets/stylesheets/guide/application.css
+- app/controllers/guide/base_controller.rb
+- app/controllers/guide/nodes_controller.rb
+- app/controllers/guide/scenarios_controller.rb
+- app/helpers/guide/application_helper.rb
+- app/helpers/guide/document_helper.rb
+- app/models/guide/arborist.rb
+- app/models/guide/bouncer.rb
+- app/models/guide/cartographer.rb
+- app/models/guide/content.rb
+- app/models/guide/default_authentication_system.rb
+- app/models/guide/default_authorisation_system.rb
+- app/models/guide/diplomat.rb
+- app/models/guide/document.rb
+- app/models/guide/endpoint_stocktaker.rb
+- app/models/guide/errors.rb
+- app/models/guide/errors/base.rb
+- app/models/guide/errors/interface_violation.rb
+- app/models/guide/errors/invalid_node.rb
+- app/models/guide/errors/invalid_scenario.rb
+- app/models/guide/errors/invalid_visibility_option.rb
+- app/models/guide/errors/permission_denied.rb
+- app/models/guide/fixture.rb
+- app/models/guide/fixtures.rb
+- app/models/guide/form_object.rb
+- app/models/guide/monkey.rb
+- app/models/guide/nobilizer.rb
+- app/models/guide/node.rb
+- app/models/guide/photographer.rb
+- app/models/guide/scout.rb
+- app/models/guide/simulator.rb
+- app/models/guide/structure.rb
+- app/models/guide/view_model.rb
+- app/view_models/guide/layout_view.rb
+- app/view_models/guide/navigation_view.rb
+- app/view_models/guide/node_view.rb
+- app/view_models/guide/scenario_layout_view.rb
+- app/view_models/guide/scenario_view.rb
+- app/views/guide/_content.html.erb
+- app/views/guide/common/_category.html.erb
+- app/views/guide/common/_footer.html.erb
+- app/views/guide/common/_locale_switcher.html.erb
+- app/views/guide/common/_navigation.html.erb
+- app/views/guide/common/_navigation_node.html.erb
+- app/views/guide/common/_page_title.html.erb
+- app/views/guide/common/_search.html.erb
+- app/views/guide/common/_unsupported_browser_message.html.erb
+- app/views/guide/common/_visibility_banner.html.erb
+- app/views/guide/nodes/_document.html.erb
+- app/views/guide/nodes/_scenario.html.erb
+- app/views/guide/nodes/_scenario_list.html.erb
+- app/views/guide/nodes/_structure.html.erb
+- app/views/guide/nodes/_template_location.html.erb
+- app/views/guide/nodes/show.html.erb
+- app/views/guide/scenarios/_scenario.html.erb
+- app/views/guide/scenarios/scenario/_locale_switcher.html.erb
+- app/views/guide/scenarios/scenario/_toolbar.html.erb
+- app/views/guide/scenarios/scenario/_visibility.html.erb
+- app/views/guide/scenarios/show.html.erb
+- app/views/layouts/guide/application.html.erb
+- app/views/layouts/guide/scenario.html.erb
+- app/views/layouts/guide/scenario/default.html.erb
+- app/views/layouts/guide/scenario/default.text.erb
+- config/initializers/assets.rb
+- config/locales/models/guide/monkey.en.yml
+- config/locales/views/guide/nodes/_structure.en.yml
+- config/routes.rb
+- lib/guide.rb
+- lib/guide/authorisation_spec_helper.rb
+- lib/guide/configuration.rb
+- lib/guide/consistency_spec_helper.rb
+- lib/guide/engine.rb
+- lib/guide/version.rb
+- lib/tasks/guide_tasks.rake
+homepage: https://github.com/envato/guide
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -38,9 +230,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
-summary: Living styleguide for your Rails app
+summary: Living documentation for your Rails application
 test_files: []