xing-framework 0.2.6 → 0.2.7.pre.beta1

data/default_configuration/base_app/frontend/package.json

@@ -18,33 +18,36 @@
     "angular-ui-utils": "~0.1.1",
     "bower": "~1.3.2",
     "breakpoint-sass": "^2.6.1",
+    "eslint": "0.x",
+    "estraverse": "~4.1.1",
     "font-awesome": "^4.4.0",
     "grunt": "^0.4.5",
-    "grunt-bump": "https://registry.npmjs.org/grunt-bump/-/grunt-bump-0.0.13.tgz",
-    "grunt-bushcaster": "https://registry.npmjs.org/grunt-bushcaster/-/grunt-bushcaster-0.0.7.tgz",
+    "grunt-bump": "^0.0.13",
+    "grunt-bushcaster": "^0.0.7",
     "grunt-cli": "~0.1.13",
     "grunt-coffeelint": "0.0.10",
-    "grunt-concat-sourcemap": "https://registry.npmjs.org/grunt-concat-sourcemap/-/grunt-concat-sourcemap-0.4.3.tgz",
-    "grunt-concurrent": "https://registry.npmjs.org/grunt-concurrent/-/grunt-concurrent-1.0.0.tgz",
-    "grunt-contrib-clean": "https://registry.npmjs.org/grunt-contrib-clean/-/grunt-contrib-clean-0.5.0.tgz",
+    "grunt-concat-sourcemap": "^0.4.3",
+    "grunt-concurrent": "^1.0.0",
+    "grunt-contrib-clean": "~0.5.0",
     "grunt-contrib-coffee": "~0.10.1",
-    "grunt-contrib-compass": "https://registry.npmjs.org/grunt-contrib-compass/-/grunt-contrib-compass-1.0.1.tgz",
-    "grunt-contrib-compress": "https://registry.npmjs.org/grunt-contrib-compress/-/grunt-contrib-compress-0.13.0.tgz",
+    "grunt-contrib-compass": "^1.0.1",
+    "grunt-contrib-compress": "^0.13.0",
     "grunt-contrib-concat": "~0.4.0",
-    "grunt-contrib-connect": "https://registry.npmjs.org/grunt-contrib-connect/-/grunt-contrib-connect-0.8.0.tgz",
-    "grunt-contrib-copy": "https://registry.npmjs.org/grunt-contrib-copy/-/grunt-contrib-copy-0.5.0.tgz",
-    "grunt-contrib-jshint": "https://registry.npmjs.org/grunt-contrib-jshint/-/grunt-contrib-jshint-0.11.2.tgz",
+    "grunt-contrib-connect": "^0.8.0",
+    "grunt-contrib-copy": "^0.5.0",
+    "grunt-contrib-jshint": "^0.11.2",
     "grunt-contrib-sass": "^0.8.1",
-    "grunt-contrib-uglify": "https://registry.npmjs.org/grunt-contrib-uglify/-/grunt-contrib-uglify-0.4.1.tgz",
-    "grunt-contrib-watch": "https://registry.npmjs.org/grunt-contrib-watch/-/grunt-contrib-watch-0.6.1.tgz",
-    "grunt-conventional-changelog": "https://registry.npmjs.org/grunt-conventional-changelog/-/grunt-conventional-changelog-1.1.0.tgz",
-    "grunt-html2js": "https://registry.npmjs.org/grunt-html2js/-/grunt-html2js-0.2.8.tgz",
-    "grunt-jsonlint": "https://registry.npmjs.org/grunt-jsonlint/-/grunt-jsonlint-1.0.4.tgz",
-    "grunt-karma": "https://registry.npmjs.org/grunt-karma/-/grunt-karma-0.8.3.tgz",
-    "grunt-ng-annotate": "https://registry.npmjs.org/grunt-ng-annotate/-/grunt-ng-annotate-0.3.2.tgz",
+    "grunt-contrib-uglify": "^0.4.0",
+    "grunt-contrib-watch": "^0.6.1",
+    "grunt-conventional-changelog": "~1.1.0",
+    "grunt-html2js": "^0.2.4",
+    "grunt-jsonlint": "~1.0.4",
+    "grunt-karma": "^0.8.3",
+    "grunt-ng-annotate": "^0.3.2",
     "grunt-string-replace": "^1.2.0",
-    "grunt-xing-index": "0.0.2",
+    "grunt-xing-index": "^0.0.2",
     "hammerjs": "~2.0.4",
+    "jasmine-core": "*",
     "jquery": "^2.1.1",
     "json": "^9.0.1",
     "jsonlint": "^1.6.2",
@@ -58,7 +61,7 @@
     "karma-sourcemap-loader": "git://github.com/LRDesign/karma-sourcemap-loader",
     "lodash": "^2.4.1",
     "relayer": "0.1.0",
-    "requirejs": "^2.1.15",
+    "requirejs": "~2.1.15",
     "responsive-nav": "~1.0.32",
     "sass-import-once": "~0.1.1",
     "singularitygs": "> 0",
@@ -68,8 +71,8 @@
     "xing-frontend-grunt": "0.0.8",
     "xing-frontend-token-auth": "0.0.3",
     "xing-frontend-utils": "0.0.1-beta6",
-    "xing-grunt-revise": "0.0.1",
+    "xing-grunt-revise": "^0.0.1",
     "xing-inflector": "0.0.2",
-    "xing-traceur": "0.0.8"
+    "xing-traceur": "^0.0.8"
   }
 }

data/default_configuration/templates/CHANGELOG.md

@@ -0,0 +1 @@
+* initial version

data/default_configuration/templates/CODE_OF_CONDUCT.md

@@ -0,0 +1,50 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at {{email}}. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/default_configuration/templates/CONTRIBUTING.md

@@ -0,0 +1 @@
+This file is a good place to put instructions about your contribution process -- how do you want teams or open source contributors to submit code code to your repository.

data/default_configuration/templates/README.md

@@ -0,0 +1,22 @@
+== {{app_name}}
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* Node/Npm Version
+
+* System dependencies
+
+* Configuration
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+{{code_of_conduct_reference}}

data/default_configuration/templates/backend/config/secrets.yml

@@ -31,6 +31,8 @@ development:
     password: password
   sitemap_base_url: http://localhost:3000/
   asset_host: http://localhost:3000/
+  # don't use this value in production
+  allowed_origins: '*'
 
 test:
   secret_key_base: {{test_secret_key_base}}
@@ -50,6 +52,7 @@ test:
     password: password
   sitemap_base_url: http://localhost:3000/
   asset_host: http://localhost:3000/
+  allowed_origins: '*'
 
 # Do not keep production secrets in the repository,
 # instead read values from the environment.

data/default_configuration/templates/backend/config/secrets.yml.ci

@@ -16,6 +16,8 @@ test:
     password: password
   sitemap_base_url: http://localhost:3000/
   asset_host: http://localhost:3000/
+  # don't use this value in production
+  allowed_origins: '*'
 
 development:
   <<: *test

data/default_configuration/templates/backend/config/secrets.yml.example

@@ -31,6 +31,8 @@ development:
     password: password
   sitemap_base_url: http://localhost:3000/
   asset_host: http://localhost:3000/
+  # don't use this value in production
+  allowed_origins: '*'
 
 test:
   secret_key_base: {{test_secret_key_base}}
@@ -50,6 +52,8 @@ test:
     password: password
   sitemap_base_url: http://localhost:3000/
   asset_host: http://localhost:3000/
+  # don't use this value in production
+  allowed_origins: '*'
 
 # Do not keep production secrets in the repository,
 # instead read values from the environment.

data/lib/xing/cli/generators/new_project/user_input.rb

@@ -0,0 +1,33 @@
+require 'highline'
+
+module Xing::CLI::Generators
+  class NewProject
+    class UserInput
+      attr_accessor :code_of_conduct, :coc_contact_email
+
+      def gather
+        self.code_of_conduct = yesno("Add a Code of Conduct? (Contributor Covenant)")
+        if code_of_conduct
+          self.coc_contact_email = highline.ask("Enter a contact email for your Code of Conduct:") { |q| q.validate = /\A[^@\s]+@([^@\s]+\.)+[^@\s]+\z/ }
+        end
+      end
+
+      protected
+
+      def highline
+        @highline ||= HighLine.new
+      end
+
+      def yesno(prompt = 'Continue?', default = true)
+        answer = ''
+        options = default ? '[Y/n]' : '[y/N]'
+        def_answer = default ? 'y' : 'n'
+        until %w[y n].include? answer
+          answer = highline.ask("#{prompt} #{options} ") { |q| q.limit = 1; q.case = :downcase }
+          answer = def_answer if answer.length == 0
+        end
+        answer == 'y'
+      end
+    end
+  end
+end

data/lib/xing/cli/generators/new_project.rb

@@ -1,12 +1,12 @@
 require 'caliph'
 require 'bundler'
-require 'architecture/dsl'
 require 'securerandom'
+require 'xing/cli/templaters'
+require 'xing/cli/generators/new_project/user_input'
 
 module Xing::CLI::Generators
   class NewProject
     include Caliph::CommandLineDSL
-    include Architecture
 
     attr_accessor :target_name
     attr_accessor :ruby_version
@@ -20,6 +20,9 @@ module Xing::CLI::Generators
     # For the moment, this is the simplest thing that can work. Zero templating
     # is done so the project will still have the default module names etc.
     def generate
+
+      user_input.gather
+
       command = cmd('cp', '-a', File.expand_path('../../../../../default_configuration/base_app/', __FILE__), target_name)
       result = shell.run(command)
 
@@ -37,10 +40,11 @@ module Xing::CLI::Generators
         write_ruby_gemset "backend"
       end
 
-      write_database_yml
-      write_secrets_yml
-
-      write_git_control_files
+      database_yml_templater.template
+      secrets_yml_templater.template
+      control_files_templater.template
+      doc_files_templater.template
+      code_of_conduct_templater.template
 
       Bundler.with_clean_env do
         if with_gemset
@@ -69,50 +73,54 @@ module Xing::CLI::Generators
 
     end
 
-    def write_database_yml
-      dbyml_path = File.join(target_name, "backend", "config", "database.yml")
-      if !File.exist?(dbyml_path)
-        with_templates do |arc|
-          arc.copy file: "backend/config/database.yml", context: { app_name: target_name }
-          arc.copy file: "backend/config/database.yml.example", context: { app_name: target_name }
-          arc.copy file: "backend/config/database.yml.ci", context: { app_name: target_name }
-        end
+    def database_yml_templater
+      @database_yml_templater ||= begin
+        dbyml_path = File.join(target_name, "backend", "config", "database.yml")
+        Xing::CLI::Templaters::DatabaseYmlTemplater.new(target_name, context, File.exist?(dbyml_path))
       end
     end
 
-    def write_git_control_files
-      with_templates do |arc|
-        arc.copy file: "gitignore", as: ".gitignore"
-        arc.copy file: "backend/gitignore", as:"backend/.gitignore"
-        arc.copy file: "frontend/gitignore", as: "frontend/.gitignore"
-        arc.copy file: "gitattributes", as: ".gitattributes"
-        arc.copy file: "backend/gitattributes", as: "backend/.gitattributes"
-        arc.copy file: "frontend/gitattributes", as: "frontend/.gitattributes"
-      end
+    def control_files_templater
+      @control_files_templater ||= Xing::CLI::Templaters::ControlFilesTemplater.new(
+        target_name, context)
     end
 
-    def write_secrets_yml
-      secyml_path = File.join(target_name, "backend", "config", "secrets.yml")
-      if !File.exist?(secyml_path)
-        context = {
-          dev_secret_key_base: SecureRandom.hex(64),
-          test_secret_key_base: SecureRandom.hex(64),
-          app_name: target_name
-        }
-        with_templates do |arc|
-          arc.copy file: "backend/config/secrets.yml", context: context
-          arc.copy file: "backend/config/secrets.yml.example", context: context
-          arc.copy file: "backend/config/secrets.yml.ci", context: context
-        end
-      end
+    def doc_files_templater
+      @doc_files_templater ||= Xing::CLI::Templaters::DocFilesTemplater.new(
+        target_name,
+        context.merge({
+          code_of_conduct_reference: (user_input.code_of_conduct ?
+            "All contributors must abide by the [Code of Conduct](CODE_OF_CONDUCT.md)" : "")
+        }))
     end
 
-    def with_templates
-      architecture source: File.expand_path('../../../../../default_configuration/templates/', __FILE__) , destination: target_name  do |arc|
-        yield(arc)
+    def secrets_yml_templater
+      @secrets_yml_templater ||= begin
+        secyml_path = File.join(target_name, "backend", "config", "secrets.yml")
+        Xing::CLI::Templaters::SecretsYmlTemplater.new(
+          target_name,
+          context.merge({
+            dev_secret_key_base: SecureRandom.hex(64),
+            test_secret_key_base: SecureRandom.hex(64),
+          }),
+          File.exist?(secyml_path)
+        )
       end
     end
 
+    def code_of_conduct_templater
+      @code_of_conduct_templater ||= Xing::CLI::Templaters::CodeOfConductTemplater.new(
+        target_name,
+        context.merge({
+          email: user_input.coc_contact_email
+        }),
+        !user_input.code_of_conduct)
+    end
+
+    def context
+      { app_name: target_name }
+    end
+
     def write_file_to(name, subdir)
       File.open(File.join(*([target_name] + subdir + [name])), "w") do |rv|
         yield(rv)
@@ -141,5 +149,10 @@ module Xing::CLI::Generators
         cmd(":")
       end
     end
+
+    def user_input
+      @user_input ||= UserInput.new
+    end
+
   end
 end

data/lib/xing/cli/templaters/code_of_conduct_templater.rb

@@ -0,0 +1,7 @@
+module Xing::CLI::Templaters
+  class CodeOfConductTemplater < Templater
+    def template_files(arc)
+      arc.copy file: "CODE_OF_CONDUCT.md", context: context
+    end
+  end
+end

data/lib/xing/cli/templaters/control_files_templater.rb

@@ -0,0 +1,12 @@
+module Xing::CLI::Templaters
+  class ControlFilesTemplater < Templater
+    def template_files(arc)
+      arc.copy file: "gitignore", as: ".gitignore"
+      arc.copy file: "backend/gitignore", as:"backend/.gitignore"
+      arc.copy file: "frontend/gitignore", as: "frontend/.gitignore"
+      arc.copy file: "gitattributes", as: ".gitattributes"
+      arc.copy file: "backend/gitattributes", as: "backend/.gitattributes"
+      arc.copy file: "frontend/gitattributes", as: "frontend/.gitattributes"
+    end
+  end
+end

data/lib/xing/cli/templaters/database_yml_templater.rb

@@ -0,0 +1,9 @@
+module Xing::CLI::Templaters
+  class DatabaseYmlTemplater < Templater
+    def template_files(arc)
+      arc.copy file: "backend/config/database.yml", context: context
+      arc.copy file: "backend/config/database.yml.example", context: context
+      arc.copy file: "backend/config/database.yml.ci", context: context
+    end
+  end
+end

data/lib/xing/cli/templaters/doc_files_templater.rb

@@ -0,0 +1,9 @@
+module Xing::CLI::Templaters
+  class DocFilesTemplater < Templater
+    def template_files(arc)
+      arc.copy file: "README.md", context: context
+      arc.copy file: "CONTRIBUTING.md"
+      arc.copy file: "CHANGELOG.md"
+    end
+  end
+end

data/lib/xing/cli/templaters/secrets_yml_templater.rb

@@ -0,0 +1,9 @@
+module Xing::CLI::Templaters
+  class SecretsYmlTemplater < Templater
+    def template_files(arc)
+      arc.copy file: "backend/config/secrets.yml", context: context
+      arc.copy file: "backend/config/secrets.yml.example", context: context
+      arc.copy file: "backend/config/secrets.yml.ci", context: context
+    end
+  end
+end

data/lib/xing/cli/templaters.rb

@@ -0,0 +1,28 @@
+require 'xing'
+require 'architecture/dsl'
+
+module Xing::CLI::Templaters
+  class Templater
+
+    include Architecture
+
+    def initialize(target_name, context, guard = false)
+      @target_name = target_name
+      @context = context
+      @guard = guard
+    end
+
+    attr_reader :target_name, :context, :guard
+
+    def template
+      if !guard
+        architecture source: File.expand_path('../../../../default_configuration/templates/', __FILE__),
+          destination: target_name  do |arc|
+          template_files(arc)
+        end
+      end
+    end
+  end
+
+  Dir[File.dirname(__FILE__) + '/templaters/*.rb'].each { |file| require file }
+end

data/spec/cli/generators/new_project/user_input_spec.rb

@@ -0,0 +1,41 @@
+require 'xing'
+require 'xing/cli/generators/new_project/user_input'
+
+describe Xing::CLI::Generators::NewProject::UserInput do
+  let :highline_mock do
+    double("HighLine")
+  end
+
+  let :user_input do
+    Xing::CLI::Generators::NewProject::UserInput.new
+  end
+
+  before do
+    expect(HighLine).to receive(:new).and_return(highline_mock)
+  end
+
+  describe "no code of conduct" do
+    before do
+      expect(highline_mock).to receive(:ask).with("Add a Code of Conduct? (Contributor Covenant) [Y/n] ").and_return('n')
+      user_input.gather
+    end
+
+    it "should have no code of conduct" do
+      expect(user_input.code_of_conduct).to eq(false)
+    end
+  end
+
+  describe "with code of conduct" do
+    before do
+      expect(highline_mock).to receive(:ask).with("Add a Code of Conduct? (Contributor Covenant) [Y/n] ").and_return('y')
+      expect(highline_mock).to receive(:ask).with("Enter a contact email for your Code of Conduct:").and_return("cheese@landofcheese.com")
+      user_input.gather
+    end
+
+    it "should have a code of conduct and a contact email" do
+      expect(user_input.code_of_conduct).to eq(true)
+      expect(user_input.coc_contact_email).to eq("cheese@landofcheese.com")
+    end
+  end
+
+end

data/spec/cli/generators/new_project_spec.rb

@@ -21,17 +21,60 @@ describe Xing::CLI::Generators::NewProject do
       npg
     end
 
+    let :templater do
+      double("templater")
+    end
+
+    let :user_input_mock do
+      double("UserInput", :code_of_conduct => true, :coc_contact_email => "abcd@gefh.com")
+    end
+
     before do
+      allow(Xing::CLI::Generators::NewProject::UserInput).to receive(:new).and_return(user_input_mock)
+      allow(user_input_mock).to receive(:gather)
       allow(File).to receive(:expand_path)
       allow(File).to receive(:open)
       allow(File).to receive(:join)
-      allow(File).to receive(:exist?)
+      allow(File).to receive(:exist?).and_return(false)
       allow(new_project_generator.shell).to receive(:run).and_return(mock_result)
       allow(new_project_generator).to receive(:cmd)
-      allow(new_project_generator).to receive(:architecture)
+      allow(templater).to receive(:template)
     end
 
-    it "should succeed" do
+    it "should succeed and do templating" do
+      expect(Xing::CLI::Templaters::SecretsYmlTemplater).to receive(:new).with(
+        "awesome",
+        {
+          dev_secret_key_base: kind_of(String),
+          test_secret_key_base: kind_of(String),
+          app_name: "awesome"
+        },
+        false).and_return(templater)
+      expect(Xing::CLI::Templaters::DatabaseYmlTemplater).to receive(:new).with(
+        "awesome",
+        {
+          app_name: "awesome"
+        },
+        false).and_return(templater)
+      expect(Xing::CLI::Templaters::DocFilesTemplater).to receive(:new).with(
+        "awesome",
+        {
+          app_name: "awesome",
+          code_of_conduct_reference: "All contributors must abide by the [Code of Conduct](CODE_OF_CONDUCT.md)"
+        }).and_return(templater)
+      expect(Xing::CLI::Templaters::CodeOfConductTemplater).to receive(:new).with(
+        "awesome",
+        {
+          app_name: "awesome",
+          email: "abcd@gefh.com"
+        },
+        false
+        ).and_return(templater)
+      expect(Xing::CLI::Templaters::ControlFilesTemplater).to receive(:new).with(
+        "awesome",
+        {
+          app_name: "awesome"
+        }).and_return(templater)
       new_project_generator.generate
     end
   end