cavendish 0.1.0

data/lib/cavendish/assets/.eslintrc.json

@@ -0,0 +1,43 @@
+{
+  "env": {
+    "es6": true,
+    "jest": true
+  },
+  "extends": "airbnb",
+  "globals": {
+    "Atomics": "readonly",
+    "SharedArrayBuffer": "readonly",
+    "jest": true
+  },
+  "parser": "babel-eslint",
+  "parserOptions": {
+    "ecmaFeatures": {
+      "jsx": true
+    },
+    "ecmaVersion": 2018,
+    "sourceType": "module"
+  },
+  "plugins": ["react"],
+  "rules": {
+    "no-console": 2,
+    "react/prop-types": ["error", { "ignore": ["route", "navigation"] }],
+    "react/jsx-first-prop-new-line": [1, "multiline"],
+    "react/jsx-max-props-per-line": [1, { "maximum": 1 }],
+    "react/jsx-one-expression-per-line": "off",
+    "global-require": "off",
+    "import/prefer-default-export": "off",
+    "import/no-extraneous-dependencies": [
+      "error",
+      { "devDependencies": ["**/*.spec.js", "src/factories/**"] }
+    ],
+    "react/jsx-filename-extension": [1, { "extensions": [".spec.js", ".jsx"] }],
+    "react/jsx-props-no-spreading": 0
+  },
+  "settings": {
+    "import/resolver": {
+      "alias": {
+        "extensions": [".js", ".jsx"]
+      }
+    }
+  }
+}

data/lib/cavendish/assets/.node-version

@@ -0,0 +1 @@
+14

data/lib/cavendish/assets/App.jsx

@@ -0,0 +1,12 @@
+import React from 'react';
+import { NavigationContainer } from '@react-navigation/native';
+
+import HomeNavigator from './src/navigators/HomeNavigator';
+
+export default function App() {
+  return (
+    <NavigationContainer>
+      <HomeNavigator />
+    </NavigationContainer>
+  );
+}

data/lib/cavendish/assets/README.md.erb

@@ -0,0 +1,59 @@
+# <%= @config.human_project_name %>
+
+This is a React Native + Expo application, initially generated using [Cavendish](https://github.com/platanus/cavendish) by Platanus.
+
+## Instalation and development
+
+Assuming you've cloned the repo and that you have [Node](https://nodejs.org/en/) and [Yarn](https://yarnpkg.com/), the first thing you need to install is the Expo CLI:
+
+```bash
+yarn global add expo-cli@4.8.x
+```
+
+Then install the project dependencies in your local machine:
+
+```bash
+yarn install
+```
+
+And you're ready to go! You can now run the project with `yarn start` and scan the QR shown in console with the [Expo Go App](https://expo.dev/client). Remember that your phone and laptop have to be connected to the same wi-fi network in order for this to work!
+
+## Continuous Integration and deployment
+
+The project has a setup to run tests and style guides in CircleCI. You can also run the test locally simulating the production environment using [CircleCI's method](https://circleci.com/docs/2.0/local-cli/).
+
+The CI workflow also takes care of deploying and [publishing your application to Expo](https://docs.expo.io/workflow/publishing/). In order for this to work, you need to:
+
+1. Create a new account in [Expo](https://expo.dev/)
+1. [_Optional_] Create an [organization](https://docs.expo.io/accounts/account-types/#creating-new-organizations)
+1. Create an [access token](https://docs.expo.io/accounts/programmatic-access/)
+1. Configure the token as a [CircleCI environment variable](https://circleci.com/docs/2.0/env-vars/)
+
+And you are done! Each time there is a commit in master, the pipeline will try to deploy the application.
+
+If it succeeds, you will be able to scan and share the app QR code through `https://expo.io/@organization-or-user-name/<%= @config.project_name %>`.
+
+## Style Guides
+
+Style guides are enforced through a CircleCI [job](.circleci/config.yml) with [reviewdog](https://github.com/reviewdog/reviewdog) as a reporter, using per-project dependencies and style configurations.
+
+Please note that this reviewdog implementation requires a GitHub user token to comment on pull requests. A token can be generated [here](https://github.com/settings/tokens), and it should have at least the `repo` option checked.
+
+The included `config.yml` assumes your CircleCI organization has a context named `org-global` with the required token under the environment variable `REVIEWDOG_GITHUB_API_TOKEN`.
+
+The project comes bundled with configuration files available in this repository. You can add or modify rules by editing the [`.eslintrc.json`](.eslintrc.json) file.
+
+You can (and should) use linter integrations for your text editor of choice, using the project's configuration.
+
+## Internal Dependencies
+
+### Tailwind RN
+We use the TailwindCSS adaptation for React Native: [`tailwind-rn`](https://github.com/vadimdemedes/tailwind-rn), in order to reduce the friction in mobile apps styling.
+
+If you need to add custom styles, make sure you follow the instructions given in the package's README.
+
+### React Navigation
+We use [React Navigation](https://reactnavigation.org/)@<%= Cavendish::REACT_NAVIGATION_VERSION %> to handle the shown screens and navigation interactions of the application.
+
+### Testing
+We use [Jest](https://jestjs.io/) and [React Native Testing Library](https://testing-library.com/docs/react-native-testing-library/intro/) in order to test the components of this app.

data/lib/cavendish/assets/src/navigators/HomeNavigator.jsx

@@ -0,0 +1,17 @@
+import React from 'react';
+import { createStackNavigator } from '@react-navigation/stack';
+
+import HomeScreen from '../screens/HomeScreen';
+
+const Stack = createStackNavigator();
+
+export default function HomeNavigator() {
+  return (
+    <Stack.Navigator>
+      <Stack.Screen
+        name="Home"
+        component={HomeScreen}
+      />
+    </Stack.Navigator>
+  );
+}

data/lib/cavendish/assets/src/screens/HomeScreen.jsx.erb

@@ -0,0 +1,16 @@
+import React, { useState } from 'react';
+import { View, Text } from 'react-native';
+
+import tailwind from '../utils/tailwindRn';
+
+export default function HomeScreen() {
+  const [projectName] = useState('<%= @config.human_project_name %>');
+
+  return (
+    <View style={tailwind('p-4 bg-gray-900 flex-1 justify-center items-center')}>
+      <Text style={tailwind('text-white')}>
+        Hello {projectName}!
+      </Text>
+    </View>
+  );
+}

data/lib/cavendish/assets/src/screens/__specs__/HomeScreen.spec.js.erb

@@ -0,0 +1,22 @@
+import React from 'react';
+<% if @config.use_enzyme? %>
+import { shallow } from 'enzyme';
+import HomeScreen from '../HomeScreen';
+
+describe('HomeScreen specs', () => {
+  it('shows application name', () => {
+    const component = shallow(<HomeScreen />);
+    expect(component.contains('<%= @config.human_project_name %>')).toBe(true);
+  });
+});
+<% else %>
+import { render } from '@testing-library/react-native';
+import HomeScreen from '../HomeScreen';
+
+describe('HomeScreen specs', () => {
+  it('shows application name', () => {
+    const component = render(<HomeScreen />);
+    expect(component.queryByText('Hello <%= @config.human_project_name %>!')).not.toBeNull();
+  });
+});
+<% end %>

data/lib/cavendish/assets/src/utils/tailwindRn.js

@@ -0,0 +1,7 @@
+import { create } from 'tailwind-rn';
+import styles from '../../styles.json';
+
+const { tailwind, getColor } = create(styles);
+
+export { getColor };
+export default tailwind;

data/lib/cavendish/assets/tailwind.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  theme: {
+    extend: {},
+  },
+  variants: {
+    extend: {},
+  },
+};

data/lib/cavendish/cli.rb

@@ -0,0 +1,53 @@
+module Cavendish
+  class CLI
+    include Commander::Methods
+
+    def run
+      config = Cavendish::Config.new
+      define_program
+      define_create_command(config)
+      run!
+    end
+
+    private
+
+    def define_program
+      program :name, 'Cavendish'
+      program :version, Cavendish::VERSION
+      program :description, 'React Native + Expo project generator for Platanus'
+    end
+
+    def define_create_command(config)
+      command('create') do |c|
+        c.syntax = 'cavendish create'
+        c.description = 'Create a new React Native + Expo project'
+        c.action do |args|
+          setup_config(config, args)
+          create_command_steps.each { |command| command.for(config: config) }
+        end
+      end
+    end
+
+    def create_command_steps
+      [
+        Cavendish::Commands::CreateExpoProject,
+        Cavendish::Commands::AddTailwind,
+        Cavendish::Commands::AddReactNavigation,
+        Cavendish::Commands::AddEslint,
+        Cavendish::Commands::AddTesting,
+        Cavendish::Commands::AddCiConfig,
+        Cavendish::Commands::AddReadme,
+        Cavendish::Commands::ConfigureGit
+      ]
+    end
+
+    def setup_config(config, args)
+      config.project_name = args.first
+      config.testing_library = choose(
+        'Which testing library would you like to use?',
+        'Enzyme (unit orientated library)',
+        '@testing-library/react-native (integration orientated library)'
+      )
+    end
+  end
+end

data/lib/cavendish/commands/add_ci_config.rb

@@ -0,0 +1,16 @@
+module Cavendish
+  module Commands
+    class AddCiConfig < Cavendish::Commands::Base
+      def perform
+        copy_ci_and_version_files
+      end
+
+      private
+
+      def copy_ci_and_version_files
+        copy_file(".circleci/config.yml", ".circleci/config.yml")
+        copy_file(".node-version", ".node-version")
+      end
+    end
+  end
+end

data/lib/cavendish/commands/add_eslint.rb

@@ -0,0 +1,33 @@
+module Cavendish
+  module Commands
+    class AddEslint < Cavendish::Commands::Base
+      def perform
+        copy_config_file
+        install_eslint_dependencies
+      end
+
+      private
+
+      def copy_config_file
+        copy_file(".eslintrc.json", ".eslintrc.json")
+      end
+
+      def install_eslint_dependencies
+        run_in_project("yarn add -D #{eslint_dependencies.join(' ')}")
+      end
+
+      def eslint_dependencies
+        %w[
+          babel-eslint
+          eslint
+          eslint-config-airbnb
+          eslint-import-resolver-alias
+          eslint-plugin-import
+          eslint-plugin-jsx-a11y
+          eslint-plugin-react
+          eslint-plugin-react-hooks
+        ]
+      end
+    end
+  end
+end

data/lib/cavendish/commands/add_react_navigation.rb

@@ -0,0 +1,45 @@
+module Cavendish
+  module Commands
+    class AddReactNavigation < Cavendish::Commands::Base
+      def perform
+        install_dependencies
+        add_example_navigator_and_screens
+        replace_app_entrypoint
+      end
+
+      private
+
+      def install_dependencies
+        run_in_project("yarn add #{react_navigation_core_dependencies.join(' ')}")
+        run_in_project("expo install #{react_navigation_side_dependencies.join(' ')}")
+      end
+
+      def add_example_navigator_and_screens
+        copy_template('src/screens/HomeScreen.jsx', 'src/screens/HomeScreen.jsx')
+        copy_file('src/navigators/HomeNavigator.jsx', 'src/navigators/HomeNavigator.jsx')
+      end
+
+      def replace_app_entrypoint
+        remove_in_project('App.js')
+        copy_file('App.jsx', 'App.jsx')
+      end
+
+      def react_navigation_core_dependencies
+        [
+          "@react-navigation/native@#{Cavendish::REACT_NAVIGATION_VERSION}",
+          "@react-navigation/stack@#{Cavendish::REACT_NAVIGATION_VERSION}"
+        ]
+      end
+
+      def react_navigation_side_dependencies
+        %w[
+          react-native-gesture-handler
+          react-native-reanimated
+          react-native-screens
+          react-native-safe-area-context
+          @react-native-community/masked-view
+        ]
+      end
+    end
+  end
+end

data/lib/cavendish/commands/add_readme.rb

@@ -0,0 +1,15 @@
+module Cavendish
+  module Commands
+    class AddReadme < Cavendish::Commands::Base
+      def perform
+        parse_and_copy_file
+      end
+
+      private
+
+      def parse_and_copy_file
+        copy_template('README.md', 'README.md')
+      end
+    end
+  end
+end

data/lib/cavendish/commands/add_tailwind.rb

@@ -0,0 +1,31 @@
+module Cavendish
+  module Commands
+    class AddTailwind < Cavendish::Commands::Base
+      def perform
+        install_tailwind_rn_dependencies
+        copy_tailwind_config_file
+        generate_tailwind_rn_styles_json
+        copy_tailwind_utils
+      end
+
+      private
+
+      def install_tailwind_rn_dependencies
+        run_in_project('yarn add tailwind-rn')
+        run_in_project('yarn add -D tailwindcss')
+      end
+
+      def copy_tailwind_config_file
+        copy_file('tailwind.config.js', 'tailwind.config.js')
+      end
+
+      def generate_tailwind_rn_styles_json
+        run_in_project('yarn run create-tailwind-rn')
+      end
+
+      def copy_tailwind_utils
+        copy_file('src/utils/tailwindRn.js', 'src/utils/tailwindRn.js')
+      end
+    end
+  end
+end

data/lib/cavendish/commands/add_testing.rb

@@ -0,0 +1,81 @@
+module Cavendish
+  module Commands
+    class AddTesting < Cavendish::Commands::Base
+      def perform
+        install_dependencies
+        add_config_to_package
+        @config.use_enzyme? ? add_enzyme_options : add_rn_testing_library_options
+        add_example_test_file
+      end
+
+      private
+
+      def install_dependencies
+        run_in_project("yarn add -D #{jest_dependencies.join(' ')}")
+      end
+
+      def add_config_to_package
+        inject_to_json_file('package.json', package_configuration)
+      end
+
+      def add_enzyme_options
+        run_in_project("yarn add -D #{enzyme_dependencies.join(' ')}")
+        inject_to_json_file('package.json', enzyme_configuration)
+      end
+
+      def add_rn_testing_library_options
+        run_in_project("yarn add -D #{rn_testing_library_dependencies.join(' ')}")
+      end
+
+      def add_example_test_file
+        copy_template(
+          'src/screens/__specs__/HomeScreen.spec.js',
+          'src/screens/__specs__/HomeScreen.spec.js'
+        )
+      end
+
+      def jest_dependencies
+        %w[
+          jest
+          fishery
+          jest-expo
+        ]
+      end
+
+      def rn_testing_library_dependencies
+        %w[
+          @testing-library/jest-dom
+          @testing-library/react-native
+        ]
+      end
+
+      def enzyme_dependencies
+        %w[
+          enzyme
+          enzyme-adapter-react-16
+          jest-enzyme
+          jest-environment-enzyme
+        ]
+      end
+
+      def package_configuration
+        {
+          scripts: { test: 'jest' },
+          jest: {
+            preset: 'jest-expo',
+            transform: { '^.+\\.[jt]sx?$': 'babel-jest' }
+          }
+        }
+      end
+
+      def enzyme_configuration
+        {
+          jest: {
+            setupFilesAfterEnv: ['jest-enzyme'],
+            testEnvironment: 'enzyme'
+          }
+        }
+      end
+    end
+  end
+end