Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: plugin rework #3

Merged
merged 42 commits into from
Mar 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
836e083
add init callback, upate code analysis, various minor changes
sergsavchuk Feb 12, 2023
0f3cd96
update example app
sergsavchuk Feb 14, 2023
4a418dc
implement a new plugin architecture(on the flutter side) and update t…
sergsavchuk Feb 15, 2023
ecce499
fix the acceptWaveform button
sergsavchuk Feb 15, 2023
bcf03b9
Implemented vosk android functions
EvgeniyVabishchevich Feb 19, 2023
26d70fa
fix several method calls on the flutter side
sergsavchuk Feb 19, 2023
147a165
remove the RECORD_AUDIO permission from the plugin manifest
sergsavchuk Feb 20, 2023
340e58a
add inputs for several parameters in the example app
sergsavchuk Feb 20, 2023
5e13e36
move mic permission check to the flutter side
sergsavchuk Feb 20, 2023
41a4aa0
send final results to the result channel, add a separate channel for …
sergsavchuk Feb 20, 2023
03104ee
Removed not used code. Created exceptions classes for situations, whe…
EvgeniyVabishchevich Feb 22, 2023
f802c54
Removed not used code. Created exceptions classes for situations, whe…
EvgeniyVabishchevich Feb 22, 2023
ab1439f
a bit of refactoring of java code
sergsavchuk Feb 23, 2023
31fe787
simplify recognizer usage
sergsavchuk Feb 23, 2023
5d58d0d
add documentation, fix linter issues
sergsavchuk Feb 28, 2023
8e82ee2
Moved exceptions classes to separate folder. Added speech service exi…
EvgeniyVabishchevich Mar 1, 2023
6d65c7d
add model creation error method call, add serveral integration tests
sergsavchuk Mar 1, 2023
e91b6cc
add integration tests, several tiny fixes
sergsavchuk Mar 2, 2023
4883fd5
add github actions draft
sergsavchuk Mar 2, 2023
0ec4df0
echo script commands
sergsavchuk Mar 2, 2023
3673e3d
github actions fixes
sergsavchuk Mar 2, 2023
202370a
github actions fixes
sergsavchuk Mar 2, 2023
10498c2
github actions fixes
sergsavchuk Mar 2, 2023
efcecbe
github actions fixes
sergsavchuk Mar 2, 2023
51e409a
github actions fixes
sergsavchuk Mar 2, 2023
cd4a178
github actions fixes
sergsavchuk Mar 2, 2023
d3ed6d5
github actions fixes
sergsavchuk Mar 2, 2023
3dc7a21
add unit tests
sergsavchuk Mar 3, 2023
96b68f7
run unit tests in github actions
sergsavchuk Mar 3, 2023
5e64960
add execution permission to the workflow scripts
sergsavchuk Mar 3, 2023
1f2796b
github actions fixes
sergsavchuk Mar 3, 2023
2bc9638
add analyze and formatting jobs
sergsavchuk Mar 6, 2023
0c8ad0f
don't run integration test if other checks failed
sergsavchuk Mar 6, 2023
08f3ba0
fix formatting
sergsavchuk Mar 6, 2023
681d7b4
update readme
sergsavchuk Mar 6, 2023
f2dd26b
bump plugin version, update CHANGELOG and LICENSE
sergsavchuk Mar 6, 2023
fb4f735
add publish check
sergsavchuk Mar 6, 2023
8a38eaa
ignore the flutter sdk folder used in Github Actions
sergsavchuk Mar 6, 2023
801c96a
implement network model loading
sergsavchuk Mar 8, 2023
e6c64b3
update example app
sergsavchuk Mar 8, 2023
4241c7c
increase the android integration test job timeout; several small fixes
sergsavchuk Mar 8, 2023
d1313f3
run workflow on pull requests; update workflow badge link
sergsavchuk Mar 8, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .fvm/fvm_config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"flutterSdkVersion": "3.7.0",
"flavors": {}
}
4 changes: 4 additions & 0 deletions .github/workflows/scripts/android_integration_test.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/bin/bash

cd example
flutter drive --driver=test_driver/test_driver.dart --target=integration_test/vosk_flutter_plugin_test.dart
4 changes: 4 additions & 0 deletions .github/workflows/scripts/install_flutter.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/bin/bash

git clone https://github.com/flutter/flutter.git --depth 1 -b stable _flutter
echo "$GITHUB_WORKSPACE/_flutter/bin" >> "$GITHUB_PATH"
93 changes: 93 additions & 0 deletions .github/workflows/vosk_flutter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
name: vosk_flutter

on:
pull_request:
paths:
- "!**.md"
- "!**.gitignore"

jobs:
analyze:
name: "Flutter analyze"
runs-on: macos-latest
timeout-minutes: 5
steps:
- name: "Checkout repository"
uses: actions/checkout@v3
- name: "Configure scripts "
run: chmod +x ./.github/workflows/scripts/*.sh
- name: "Install Flutter"
run: ./.github/workflows/scripts/install_flutter.sh
- name: "Run flutter analyze"
run: flutter analyze lib test

check_formatting:
name: "Check formatting"
runs-on: macos-latest
timeout-minutes: 5
steps:
- name: "Checkout repository"
uses: actions/checkout@v3
- name: "Configure scripts "
run: chmod +x ./.github/workflows/scripts/*.sh
- name: "Install Flutter"
run: ./.github/workflows/scripts/install_flutter.sh
- name: "Check dart formatting"
run: dart format --set-exit-if-changed lib test

unit_test:
name: "Unit test"
runs-on: macos-latest
timeout-minutes: 5
steps:
- name: "Checkout repository"
uses: actions/checkout@v3
- name: "Configure scripts "
run: chmod +x ./.github/workflows/scripts/*.sh
- name: "Install Flutter"
run: ./.github/workflows/scripts/install_flutter.sh
- name: "Run unit tests"
run: flutter test test/

android_integration_test:
name: "Android integration test"
runs-on: macos-latest
timeout-minutes: 40
needs: [analyze, check_formatting, unit_test]
steps:
- name: "Checkout repository"
uses: actions/checkout@v3
- name: "Configure scripts "
run: chmod +x ./.github/workflows/scripts/*.sh

- name: "Install Flutter"
run: ./.github/workflows/scripts/install_flutter.sh
- uses: actions/setup-java@v3
with:
distribution: "temurin"
java-version: "11"

- name: "Android Integration Test"
uses: reactivecircus/android-emulator-runner@v2
with:
api-level: 33
cores: 3
target: google_apis
arch: x86_64
profile: Nexus 5X
script: ./.github/workflows/scripts/android_integration_test.sh

pub_dev_publish_check:
name: "Check pub.dev requirements"
timeout-minutes: 5
runs-on: macos-latest
needs: [android_integration_test]
steps:
- name: "Checkout repository"
uses: actions/checkout@v3
- name: "Configure scripts "
run: chmod +x ./.github/workflows/scripts/*.sh
- name: "Install Flutter"
run: ./.github/workflows/scripts/install_flutter.sh
- name: "Publish check"
run: flutter pub publish --dry-run
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,12 @@
.dart_tool/
.packages
build/

# FVM
.fvm/flutter_sdk

# asdf
.tool-versions

# Ignore the flutter sdk dir used in Github Actions
_flutter/
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 2.0.0

- Plugin rework

## 0.0.1

* TODO: Describe initial release.
- Initial release
177 changes: 176 additions & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1 +1,176 @@
TODO: Add your license here.
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. this License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS
Empty file removed README
Empty file.
Loading