textualize 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af940a0bcbb1bca548ca4e51e84f68b5d69acaba
+  data.tar.gz: de4ec19be34141abc6612c767e861771819dab32
+SHA512:
+  metadata.gz: 1b6ceb22aa93feea2da4318fcd4a20bb356e96f497791ed99c43e5d834359ab56c0fc476e68376097c4bf26de746b865ec3e27be9708d254cd965faa912f4649
+  data.tar.gz: ba3df8ebf284c32d7dd086bffcb4c09f4b8db37902c8acd18b2eba909a0c8a12e5f5e9ed6913815594d66e4ce022d98c3a7beb70b718c7a003eb2f7b6eadc555

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+**/*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,28 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual
+language or imagery, derogatory comments or personal attacks, trolling, public
+or private harassment, insults, or other 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. Project maintainers who do not
+follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by opening an issue or contacting one or more of the project
+maintainers.
+
+This Code of Conduct is adapted from the [Contributor
+Covenant](http:contributor-covenant.org), version 1.0.0, available at
+[http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in textualize.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1 @@
+© Copyright 2015 - Q-Centrix LLC - MIT License

data/README.md

@@ -0,0 +1,76 @@
+# Textualize
+
+A documentation template written in RAML and thor tasks to turn documentation
+into so much more.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'textualize'
+```
+
+## Usage
+
+Textualize comes with the following generators:
+
+### New
+
+```bash
+textualize new <folder-name>
+```
+
+The ``textualize new`` command creates sample documentation with the folder
+structure needed for the other commands.
+
+### Server
+
+```bash
+textualize server
+```
+
+The ``textualize server`` command creates a folder structure of JSON in the
+``server`` folder.
+
+### HttpBackend
+
+```bash
+textualize http_backend
+```
+
+The ``textualize http_backend`` command creates a minified javascript file,
+``angular/textualize_http_backend.min.js`` that contains an angular module that
+can be injected to provide a stubbed
+[httpBackend](https://docs.angularjs.org/api/ngMockE2E/service/$httpBackend).
+This can be used in both e2e tests and for prototyping.
+
+### Request Specs
+
+```bash
+textualize request_specs
+```
+
+The ``textualize request_specs`` command creates a folder of request specs
+written in [airborne](https://github.com/brooklynDev/airborne) that can be used
+writing ruby apps with Rack. It is recommended that tests are run in isolation
+while developing, and as a suite in continuous integration.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release` to create a git tag for the version, push git
+commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/textualize/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "textualize"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/textualize

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'thor'
+
+require_relative '../lib/textualize'
+
+Textualize::Textualize.start

data/circle.yml

@@ -0,0 +1,8 @@
+dependencies:
+  post:
+    - npm install -g gulp
+
+test:
+  override:
+    - bundle exec rspec spec
+    - bundle exec cucumber features

data/lib/textualize.rb

@@ -0,0 +1,33 @@
+Dir["#{__dir__}/**/*.rb"].each { |file| require file }
+
+module Textualize
+  class Textualize < Thor
+    register(
+      ::Textualize::New,
+      'new',
+      'new',
+      'create a new documentation project'
+    )
+
+    register(
+      ::Textualize::Server,
+      'server',
+      'server',
+      'create a folder structure of json responses'
+    )
+
+    register(
+      ::Textualize::HttpBackend,
+      'http_backend',
+      'http_backend',
+      'create an Angular 1.x module for stubbing backend responses'
+    )
+
+    register(
+      ::Textualize::RequestSpecs,
+      'request_specs',
+      'request_specs',
+      'create requset specs using airborne'
+    )
+  end
+end

data/lib/textualize/tasks/helpers/route_hash_creator.rb

@@ -0,0 +1,62 @@
+require 'attr_extras'
+require 'hashie'
+
+module Textualize
+  class RouteHashCreator
+
+    pattr_initialize :json_from_gulp_task
+
+    def create_route_hashes
+      json_from_gulp_task.fetch('resources').flat_map do |resource|
+        create_method_hashes(resource)
+      end
+    end
+
+    private
+
+    def create_method_hashes(resource, relativeUri=nil)
+      relative_path = if relativeUri
+                        relativeUri + resource.fetch('relativeUri')
+                      else
+                        resource.fetch('relativeUri')
+                      end
+
+      method_hashes = []
+      method_hashes += resource.fetch('methods').map do |method|
+        method_hash = Hashie::Mash.new
+        method_hash.verb          = method.fetch('method')
+        method_hash.url           = base_path + relative_path
+        method_hash.relative_path = relative_path
+        method_hash.type          = resource.fetch('type').keys.first
+        method_hash.secured_by    = method.fetch('securedBy').first.
+          fetch('oauth_2_0').fetch('scopes')
+        method_hash.name          = relative_path.split('/').last.gsub(
+          /{|}|_id/, ''
+        )
+        method_hash.merge!(transformed_response(method))
+      end
+
+      if resource.has_key? 'resources'
+        resource.fetch('resources').each do |nested_resource|
+          method_hashes += create_method_hashes(nested_resource, relative_path)
+        end
+      end
+
+      return method_hashes
+    end
+
+    def base_path
+      URI(json_from_gulp_task.fetch('baseUri')).path
+    end
+
+    def transformed_response(method_hash)
+      response = method_hash.fetch('responses')
+
+      case response.keys.first
+      when '200' then ::Textualize::TwoHundred.new(response).transform
+      when '204' then ::Textualize::TwoHundredFour.new(response).transform
+      end
+    end
+
+  end
+end

data/lib/textualize/tasks/helpers/route_hashes.rb

@@ -0,0 +1,21 @@
+module Textualize
+  class RouteHashes
+    class << self
+      def hashes
+        fail 'run gulp first' if raml_json_files.empty?
+
+        raml_json_files.flat_map do |json_file|
+          json = JSON.parse(File.read(json_file))
+
+          RouteHashCreator.new(json).create_route_hashes
+        end
+      end
+
+      private
+
+      def raml_json_files
+        Dir.glob('.tmp/apis/*.json')
+      end
+    end
+  end
+end

data/lib/textualize/tasks/helpers/transformers/two_hundred.rb

@@ -0,0 +1,30 @@
+require 'attr_extras'
+
+module Textualize
+  class TwoHundred
+
+    pattr_initialize :response
+
+    def transform
+      transformed_hash = {}
+
+      transformed_hash[:response_code] = response.keys.first.to_i
+
+      transformed_hash[:body] = fetch_example
+
+      return transformed_hash
+    end
+
+    private
+
+    def fetch_example
+      string_body = response.
+        fetch('200').
+        fetch('body').
+        fetch('application/json').
+        fetch('example')
+
+      JSON.parse(string_body)
+    end
+  end
+end

data/lib/textualize/tasks/helpers/transformers/two_hundred_four.rb

@@ -0,0 +1,17 @@
+require 'attr_extras'
+
+module Textualize
+  class TwoHundredFour
+
+    pattr_initialize :response
+
+    def transform
+      transformed_hash = {}
+
+      transformed_hash[:response_code] = response.keys.first.to_s.to_i
+
+      return transformed_hash
+    end
+
+  end
+end

data/lib/textualize/tasks/http_backend.rb

@@ -0,0 +1,59 @@
+require 'uglifier'
+require 'erb'
+
+module Textualize
+  class HttpBackend < Thor::Group
+    include Thor::Actions
+
+    desc(
+      'Creates an angular 1.x module based off ngMockE2E that stubs a backend'
+    )
+
+    def create_angular_module
+      create_basic_http_backend_file
+
+      append_uglified_hashes
+    end
+
+    private
+
+    def create_basic_http_backend_file
+      File.open(dist_file, 'w') do |file|
+        file.write(
+          Uglifier.compile(
+            File.read("#{template_directory}/module.js")
+          )
+        )
+      end
+    end
+
+    def dist_file
+      FileUtils.mkdir_p('dist/angular/backend')
+
+      'dist/angular/backend/fake_http_backend.min.js'
+    end
+
+    def http_backend_template(route_hash)
+      ERB.new(
+        File.read("#{template_directory}/#{route_hash.verb}.js.erb")
+      ).result(route_hash.instance_eval { binding })
+    end
+
+    def template_directory
+      path = File.join(__dir__, '..', 'templates/http_backend')
+      File.expand_path(path)
+    end
+
+    def append_uglified_hashes
+      RouteHashes.hashes.each do |route_hash|
+        File.open(dist_file, 'a') do |file|
+          file.write(
+            Uglifier.compile(
+              http_backend_template(route_hash)
+            )
+          )
+        end
+      end
+    end
+  end
+end

data/lib/textualize/tasks/new.rb

@@ -0,0 +1,44 @@
+module Textualize
+  class New < Thor::Group
+    include Thor::Actions
+
+    argument :app_name, desc: 'Name for your documentation folder'
+    desc('Creates an initial folder structure for writing documentation')
+
+    def self.source_root
+      __dir__.chomp('/tasks')
+    end
+
+    def create_application_directory
+      directory "#{lib_directory}/templates/new/", app_name
+    end
+
+    def installation_complete
+      puts <<-POST_INSTALL_MESSAGE
+♪┏(°.°)┛┗(°.°)┓┗(°.°)┛┏(°.°)┓┏(°.°)┛┗(°.°)┓┗(°.°)┛┏(°.°)┓♪
+
+Thank you for installing textualize, please finish setting up your
+project with: `cd #{app_name} && npm install`
+
+In your new folder you can now use the following commands:
+
+* textualize server
+* textualize request_specs
+* textualize seeds
+* textualize factories
+
+Each command depends on gulp being installed. Please install gulp globally with
+``npm install -g gulp`` and locally with ``npm install``.
+
+♪┏(°.°)┛┗(°.°)┓┗(°.°)┛┏(°.°)┓┏(°.°)┛┗(°.°)┓┗(°.°)┛┏(°.°)┓♪
+      POST_INSTALL_MESSAGE
+    end
+
+    private
+
+    def lib_directory
+      __dir__.chomp('/tasks')
+    end
+
+  end
+end